Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.novell.service.nds
Class NdsCaseIgnoreList

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

public class NdsCaseIgnoreList
extends java.lang.Object
implements NdsAttributeValue, , java.lang.Cloneable, java.io.Serializable

Provides access to values of the Case Ignore List attribute. It is used for attributes whose values are ordered sequences of strings for which the case (upper or lower) is not significant when performing comparisons.

Two Case Ignore Lists match for equality if and only if the number of strings in each is the same, and all corresponding strings match. For two corresponding strings in the list to match they must be the same length and their corresponding characters must be identical. In matching attributes that conform to this syntax, NDS omits those spaces that are not significant (leading spaces, trailing spaces, and multiple consecutive internal spaces). The NDS stores insignificant spaces with the attribute value.

Matching Rules: Equality

See Also:
  `NdsSyntaxId`, Serialized Form

Constructor Summary
`NdsCaseIgnoreList(java.lang.String[] value)` Constructs an NdsCaseIgnoreList object from a String array of values.

Method Summary
`boolean` | `approximate(java.lang.Object anObject)` Compares two Objects using the approximate matching rule.
`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.
`int` | `count()` Returns the number of elements in this sequence.
`boolean` | `equals(java.lang.Object anObject)` Compares two Objects for equality.
`java.lang.String[]` | `getCaseIgnoreList()` Returns the String array containing a list of strings stored in the NDS attribute.
`int` | `getNdsSyntaxId()` Returns the int that represents the NDS syntax ID.
`java.util.Enumeration` | `getValues()` Returns an enumeration of element values in this sequence.
`boolean` | `supportsMatchingRules(int matchingRules)` Checks to see if this object supports the specified matching rules.
`java.lang.String` | `toString()` Generates and returns a string representation of the object.

Methods inherited from class java.lang.Object
`finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### NdsCaseIgnoreList

    public NdsCaseIgnoreList(java.lang.String[] value)

  Constructs an NdsCaseIgnoreList object from a String array of values. This array is copied to make the attribute value immutable.

  Two case ignore lists match for equality if and only if the number of strings in each is the same, and all corresponding strings match. For two corresponding strings in the list to match they must be the same length and their corresponding characters must be identical (according to the rules for case ignore strings).

  Parameters:
    `value` - The String array of stored values.

Method Detail

### compareTo

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

  Compares two objects for ordering, or compares two strings lexicographically. The compareTo method does not apply to the NdsCaseIgnoreList syntax because this syntax does not support the ordering and substrings matching rules.

### 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

### count

    public int count()

  Returns the number of elements in this sequence.
  Specified by:
    count in interface
  Returns:
    The number of elements in this sequence as an int.

### getValues

    public java.util.Enumeration getValues()

  Returns an enumeration of element values in this sequence.
  Specified by:
    getValues in interface
  Returns:
    An enumeration of element values.

### 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 NdsCaseIgnoreList 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 the 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 NdsCaseIgnoreList syntax supports only the equality matching rule.

  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.
  Overrides:
    clone in class java.lang.Object

### toString

    public java.lang.String toString()

  Generates and returns a string representation of the object. In general, the toString method returns a string that textually represents this object. The result should be a concise but informative representation that is easy to read.
  Returns:
    A String representation of the object.
  Overrides:
    toString in class java.lang.Object

### getCaseIgnoreList

    public java.lang.String[] getCaseIgnoreList()

  Returns the String array containing a list of strings stored in the NDS attribute.
  Returns:
    The String array of stored attribute values.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD