Package com.isode.dsapi.syntax

Class Selector

java.lang.Object

com.isode.dsapi.syntax.Selector

All Implemented Interfaces:

Comparable<Selector>

public class Selector
extends Object
implements Comparable<Selector>

This class stores information about a presentation address selector in the following formats: HEX and IA5.

This is an immutable class.

Examples:

"abc"

"ABC+123"

'00FF'H

'ab0a'H

Future enhancements:

1. Support US GOSIP format.

Since:

15.0

Author:

mv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Selector.SelectorType	An enumeration defining the different address formats that can be used to create a selector.

Constructor Summary

Constructors

Constructor	Description
Selector(Selector.SelectorType type, String value)	Constructor to create an object with the given data.
Selector(String str)	Constructor to create an object with the given data.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Selector o)
boolean	equals(Object other)
Selector	getCanonicalForm()	The value is converted to lower case for Selector type HEX.
String	getDisplayString()	Returns string form to display.
Selector.SelectorType	getType()	Returns the type of the selector.
String	getValue()	Returns the value of the selector.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Selector

public Selector(Selector.SelectorType type,
 String value)
         throws BadValueException

Constructor to create an object with the given data.

Parameters:

type - Type of the selector.

value - Value of the selector.

Throws:

BadValueException - if any of the input is invalid.

Selector

public Selector(String str)
         throws BadValueException

Constructor to create an object with the given data.

Parameters:

str - String representation of the selector.

Throws:

BadValueException - if the input is invalid.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getValue

public String getValue()

Returns the value of the selector.

Returns:

Value of the selector.

getType

public Selector.SelectorType getType()

Returns the type of the selector.

Returns:

Type of the selector.

getDisplayString

public String getDisplayString()

Returns string form to display.

Returns:

String form to display.

getCanonicalForm

public Selector getCanonicalForm()

The value is converted to lower case for Selector type HEX.

Returns:

canonical form of object.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Selector o)

Specified by:

compareTo in interface Comparable<Selector>