com.interstarinc.xmedius.sendfax.model
Class FaxResolution

java.lang.Object
  com.interstarinc.xmedius.sendfax.model.FaxResolution

public final class FaxResolution
extends Object

This type safe enum class defines the fax resolution values

Version:

$Revision: 1.6 $

Author:

André Morin

See Also:

IFaxOptions.getFaxResolution()

Field Summary

static FaxResolution	FINE
static FaxResolution	HIGH
static FaxResolution	LOW
private String	resolution
static FaxResolution	ULTRA_FINE

Constructor Summary

private

FaxResolution(String resolution)

Method Summary

static FaxResolution	getValueFor(String resolution) A utility method to convert a String into a FaxResolution.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOW

public static final FaxResolution LOW

HIGH

public static final FaxResolution HIGH

FINE

public static final FaxResolution FINE

ULTRA_FINE

public static final FaxResolution ULTRA_FINE

resolution

private String resolution

Constructor Detail

FaxResolution

private FaxResolution(String resolution)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

Returns:

This fax resolution string representation
The XML builder uses this value when converting the fax model to the XML document.

getValueFor

public static FaxResolution getValueFor(String resolution)
                                 throws IllegalArgumentException

A utility method to convert a String into a FaxResolution.
This is the inverse of toString().

Parameters:

resolution - a fax resolution id to be converted.
Expected values : any value returned by toString() applied on a instance of this class.

Returns:

The FaxResolution instance that matches the input parameter.
Comparison is case insensitive.

Throws:

IllegalArgumentException - if the input parameter is not an expected value.

See Also:

toString()