Package org.daisy.dotify.api.translator

Class TranslatorSpecification

java.lang.Object

org.daisy.dotify.api.translator.TranslatorSpecification

All Implemented Interfaces:

Comparable<TranslatorSpecification>

public class TranslatorSpecification
extends Object
implements Comparable<TranslatorSpecification>

Provides a translator specification.

Constructor Summary

Constructors

Constructor	Description
TranslatorSpecification(String locale, String mode)	Creates a new translator specification with the supplied values.
TranslatorSpecification(String locale, TranslatorMode mode)	Creates a new translator specification with the supplied values.

Method Summary

Modifier and Type	Method	Description
int	compareTo(TranslatorSpecification o)
boolean	equals(Object obj)
String	getLocale()	Gets the locale.
String	getMode()	Gets the translator mode.
TranslatorMode	getModeDetails()	Gets the translator mode details.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranslatorSpecification

public TranslatorSpecification(String locale,
                               String mode)

Creates a new translator specification with the supplied values.

Parameters:

locale - a locale as defined by IETF RFC 3066

mode - a translator mode

Throws:

IllegalArgumentException - if null/empty values are inserted

TranslatorSpecification

public TranslatorSpecification(String locale,
                               TranslatorMode mode)

Creates a new translator specification with the supplied values.

Parameters:

locale - a locale as defined by IETF RFC 3066

mode - a translator mode

Throws:

IllegalArgumentException - if null/empty values are inserted

Method Detail

getLocale

public String getLocale()

Gets the locale.

Returns:

the locale

getMode

public String getMode()

Gets the translator mode.

Returns:

the translator mode

getModeDetails

public TranslatorMode getModeDetails()

Gets the translator mode details.

Returns:

the translator mode details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(TranslatorSpecification o)

Specified by:

compareTo in interface Comparable<TranslatorSpecification>

toString

public String toString()

Overrides:

toString in class Object