Skip navigation links

com.octetstring.vde.syntax
Class BinarySyntax

java.lang.Object
com.octetstring.vde.syntax.Syntax
com.octetstring.vde.syntax.BinarySyntax

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class BinarySyntax

extends Syntax

implements java.io.Serializable, java.lang.Comparable

See Also:

Serialized Form

Constructor Summary

BinarySyntax()

BinarySyntax(byte[] value)

BinarySyntax(byte[] value, int hashCode)

Method Summary

int	compareTo(BinarySyntax bin)
int	compareTo(java.lang.Object obj)
int	compareTo(Syntax val) Compares the value in this syntax with the value in another syntax object.
boolean	endsWith(Syntax val) Checks to see if the passed value is at the end of this value.
boolean	equals(BinarySyntax bin)
boolean	equals(java.lang.Object obj)
byte[]	getBytes()
byte[]	getValue() Get a byte array representation of this value.
int	hashCode()
int	indexOf(BinarySyntax indexString)
int	indexOf(Syntax val) Find the first occurance of the passed syntax within this syntax.
int	length()
java.lang.String	normalize() Perform necessary steps to create an indexable String representation of this value.
Syntax	reverse() Returns the reverse of this string.
void	setValue(byte[] value) Set this value to the passed byte array according to appropriate rules.
void	setValue(byte[] value, int hashCode) Set this value to the passed bye array according to appropriate rules.
boolean	startsWith(Syntax val) Determines if the specified value is at the beginning of this value.
java.lang.String	toString()
void	validate() Determines if this value is in accordance to the syntax rules (if any)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BinarySyntax

public BinarySyntax()

BinarySyntax

public BinarySyntax(byte[] value)

BinarySyntax

public BinarySyntax(byte[] value,
                    int hashCode)

Method Detail

getValue

public byte[] getValue()

Description copied from class: Syntax

Get a byte array representation of this value. This method allows the value to be sent as an octet string value via LDAP.

Specified by:

getValue in class Syntax

Returns:

a byte[] value

setValue

public void setValue(byte[] value)

Description copied from class: Syntax

Set this value to the passed byte array according to appropriate rules.

Specified by:

setValue in class Syntax

Parameters:

value - a byte[] value

setValue

public void setValue(byte[] value,
                     int hashCode)

Description copied from class: Syntax

Set this value to the passed bye array according to appropriate rules. This version of the method also takes a hashCode to save computation time when it is already known.

Specified by:

setValue in class Syntax

Parameters:

value - a byte[] value

hashCode - an int value

compareTo

public int compareTo(BinarySyntax bin)

compareTo

public int compareTo(Syntax val)

Description copied from class: Syntax

Compares the value in this syntax with the value in another syntax object. Returns an int less than 0 if this value is less, 0 if equal, or a value greater than 0 if this value is greater.

Specified by:

compareTo in class Syntax

Parameters:

val - a Syntax value

Returns:

an int value

compareTo

public int compareTo(java.lang.Object obj)

Specified by:

compareTo in interface java.lang.Comparable

endsWith

public boolean endsWith(Syntax val)

Description copied from class: Syntax

Checks to see if the passed value is at the end of this value. Returns true if so, false if not, or if such a comparison is inappropriate (with an int, for example).

Specified by:

endsWith in class Syntax

Parameters:

val - a Syntax value

Returns:

a boolean value

equals

public boolean equals(BinarySyntax bin)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBytes

public byte[] getBytes()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

indexOf

public int indexOf(BinarySyntax indexString)

indexOf

public int indexOf(Syntax val)

Description copied from class: Syntax

Find the first occurance of the passed syntax within this syntax.

Specified by:

indexOf in class Syntax

Parameters:

val - a Syntax value

Returns:

an int value

length

public int length()

normalize

public java.lang.String normalize()

Description copied from class: Syntax

Perform necessary steps to create an indexable String representation of this value.

Specified by:

normalize in class Syntax

Returns:

a String value

reverse

public Syntax reverse()

Description copied from class: Syntax

Returns the reverse of this string. Useful for substring final indexes.

Specified by:

reverse in class Syntax

Returns:

a Syntax value

startsWith

public boolean startsWith(Syntax val)

Description copied from class: Syntax

Determines if the specified value is at the beginning of this value. Returns true if it is, false if not or if the comparison is inappropirate.

Specified by:

startsWith in class Syntax

Parameters:

val - a Syntax value

Returns:

a boolean value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validate

public void validate()
              throws com.octetstring.vde.syntax.InvalidSyntaxException

Description copied from class: Syntax

Determines if this value is in accordance to the syntax rules (if any)

Specified by:

validate in class Syntax

Throws:

com.octetstring.vde.syntax.InvalidSyntaxException

Skip navigation links