com.novell.service.nds
Class NdsInteger

java.lang.Object
  |
  +--com.novell.service.nds.NdsInteger

public class NdsInteger

extends java.lang.Object

implements NdsAttributeValue, , java.lang.Cloneable, java.io.Serializable

Provides access to values of the Integer attribute. It is used for attributes whose values are signed integers. The attributes for two integers match for equality if they are the same. The comparison for ordering uses signed integer rules. Attributes using this syntax can set size limits.

Matching Rules: Equality and Ordering

See Also:

NdsSyntaxId

Constructor Summary

NdsInteger(long value)
Constructs an NdsInteger object based on the specified value parameter.

Method Summary

boolean	approximate(java.lang.Object anObject) Compares two Objects using the approximate matching rule.
byte	byteValue() Returns the value of this NDS object as a byte.
java.lang.Object	clone() Creates a new object of the same class as this object.
int	compareTo(java.lang.Object anObject) Compares two objects for ordering, or compares two strings lexicographically.
double	doubleValue() Returns the value of this NDS object as a double.
boolean	equals(java.lang.Object anObject) Compares two Objects for equality.
float	floatValue() Returns the value of this NDS object as a float.
long	getInteger() Returns the integer as a long value (Java) representation.
int	getNdsSyntaxId() Returns the int that represents this NDS syntax ID.
int	intValue() Returns the value of this NDS object as an int.
long	longValue() Returns the value of this NDS object as a long.
short	shortValue() Returns the value of this NDS object as a short.
boolean	supportsMatchingRules(int matchingRules) Checks to see if this object supports the specified matching rules.
java.lang.String	toString() Generates a string representation of the object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NdsInteger

public NdsInteger(long value)

Constructs an NdsInteger object based on the specified value parameter.

Parameters:

value - The long value of the signed integer to be stored.

Method Detail

compareTo

public int compareTo(java.lang.Object anObject)
              throws java.lang.Exception

Compares two objects for ordering, or compares two strings lexicographically. For the Integer syntax, the compareTo method compares this NDS Object with a reference NDS Object contained in the anObject parameter. The comparison is done according to the Ordering matching rule for this syntax.

Parameters:

anObject - The reference NDS Object with which to compare.

Returns:

An int set to 0 if the reference Object is equal to this Object; an int <0 if the reference Object is less than this Object; an int >0 if the reference Object is greater than this Object.

Throws:

java.lang.IllegalArgumentException - The passed-in object is of a different type than this NDS Object.

equals

public boolean equals(java.lang.Object anObject)

Compares two Objects for equality. The equals method compares this object value with the value of the reference object in the anObject parameter.

The equals method implements the most discriminating possible equivalence relation on objects; that is, for any reference values X and Y, this method returns TRUE if and only if X and Y refer to the same object (X==Y has the value TRUE).

Parameters:

anObject - The reference object with which to compare.

Returns:

A boolean set to TRUE if and only if the argument is not NULL and is an NDS integer object that contains the same value as this object, otherwise set to FALSE.

Overrides:

equals in class java.lang.Object

intValue

public int intValue()

Returns the value of this NDS object as an int.

Specified by:

intValue in interface

Returns:

The int value of this NDS object.

longValue

public long longValue()

Returns the value of this NDS object as a long.

Specified by:

longValue in interface

Returns:

The long value of this NDS object.

floatValue

public float floatValue()

Returns the value of this NDS object as a float.

Specified by:

floatValue in interface

Returns:

The float value of this NDS object.

doubleValue

public double doubleValue()

Returns the value of this NDS object as a double.

Specified by:

doubleValue in interface

Returns:

The double value of this NDS object.

byteValue

public byte byteValue()

Returns the value of this NDS object as a byte.

Specified by:

byteValue in interface

Returns:

The byte value of this NDS object.

shortValue

public short shortValue()

Returns the value of this NDS object as a short.

Specified by:

shortValue in interface

Returns:

The short value of this NDS object.

approximate

public boolean approximate(java.lang.Object anObject)
                    throws java.lang.Exception

Compares two Objects using the approximate matching rule. The approximate method does not apply to the NdsInteger syntax because this syntax does not support the approximate equals matching rule.

Specified by:

approximate in interface NdsAttributeValue

getNdsSyntaxId

public int getNdsSyntaxId()

Returns the int that represents this NDS syntax ID.

Specified by:

getNdsSyntaxId in interface NdsAttributeValue

Returns:

The syntax ID as an int.

supportsMatchingRules

public boolean supportsMatchingRules(int matchingRules)

Checks to see if this object supports the specified matching rules. The NdsInteger syntax supports the Equality and Ordering matching rules.

Specified by:

supportsMatchingRules in interface NdsAttributeValue

Parameters:

matchingRules - The set of matching rules to check.

Returns:

A Boolean set to TRUE if the matching rules for this object are equal to the matchingRules parameter.

clone

public java.lang.Object clone()

Creates a new object of the same class as this object. It then initializes each of the new object's fields by assigning them the same value as the corresponding fields in this object. No constructor is called.

Returns:

A clone of this object instance containing the cloned syntax.

toString

public java.lang.String toString()

Generates a string representation of the object. It returns a string that textually represents the object. The result should be a concise but informative representation that is easy to read.

Returns:

The String representation of the object.

Overrides:

toString in class java.lang.Object

getInteger

public long getInteger()

Returns the integer as a long value (Java) representation.

Returns:

The integer as a long value.