com.novell.admin.ns
Class ValueListFacade

java.lang.Object
  |
  +--com.novell.admin.ns.ValueListFacade
Direct Known Subclasses:
BackLinkFacade, CaseIgnoreListFacade, DateNameFacade, DeletedFileInfoFacade, DirectoryEntryInfoFacade, DirectorySpaceInfoFacade, EmailAddressFacade, ExtendedAttributeFacade, FaxNumberFacade, HoldFacade, NetAddressFacade, ObjectACLFacade, OctetListFacade, PathFacade, PostalAddressFacade, ReplicaPointerFacade, TimeStampFacade, TrusteeFacade, TypedNameFacade, UnknownFacade, VolumeInformationFacade, VolumeRestrictionFacade, VolumeUtilizationFacade

public abstract class ValueListFacade
extends java.lang.Object

The ValueList facade provides a simple interface to values that correspond to composite syntaxes.

Instead of finding a specific value component by enumerating each component of the ValueList or through the value component's index, the facades provide methods to extract and set specific value components directly to and from the value list.

If a new SyntaxListStrategy is added, this class must be extended by a corresponding new facade.


Field Summary
protected  ValueList valueList
          The list of value components contained in the facade.
 
Constructor Summary
ValueListFacade(ValueList valueList)
          Constructor.
 
Method Summary
 ValueList getValueList()
          Returns the ValueList associated with this facade.
protected  void replaceBooleanValue(boolean value, int index)
          Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a boolean.
protected  void replaceHexValue(byte[] value, int index)
          Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a byte[].
protected  void replaceLongValue(long value, int index)
          Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a long.
protected  void replaceStringValue(java.lang.String str, int index)
          Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a string.
protected  void replaceValueList(ValueList newValue, int index)
          Helper method that encapsulates the procedure for replacing a specific Value in a ValueList with a new component created from a ValueList.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

valueList

protected ValueList valueList
The list of value components contained in the facade.
Constructor Detail

ValueListFacade

public ValueListFacade(ValueList valueList)
Constructor.
Parameters:
valueList - The ValueList object to associate with this facade.
Method Detail

getValueList

public final ValueList getValueList()
Returns the ValueList associated with this facade.
Returns:
The ValueList

replaceStringValue

protected final void replaceStringValue(java.lang.String str,
                                        int index)
                                 throws java.lang.ArrayIndexOutOfBoundsException
Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a string.
Parameters:
str - The String used to construct the new Value.
index - The index of the ValueComponent to replace.
Returns:
True if valueComponent was replaced, otherwise false.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is not in the value list.

replaceLongValue

protected final void replaceLongValue(long value,
                                      int index)
                               throws java.lang.ArrayIndexOutOfBoundsException
Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a long.
Parameters:
value - The long used to construct the new value.
index - The index of the ValueComponent to replace.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is not in the value list.

replaceHexValue

protected final void replaceHexValue(byte[] value,
                                     int index)
                              throws java.lang.ArrayIndexOutOfBoundsException
Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a byte[].
Parameters:
value - The byte[] used to construct the new value.
index - The index of the ValueComponent to replace.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is not in the value list.

replaceBooleanValue

protected final void replaceBooleanValue(boolean value,
                                         int index)
                                  throws java.lang.ArrayIndexOutOfBoundsException
Helper method that encapsulates the procedure for replacing a specific value in a ValueList with a new component created from a boolean.
Parameters:
value - The boolean used to construct the new Value.
index - The index of the ValueComponent to replace.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is not in the value list.

replaceValueList

protected final void replaceValueList(ValueList newValue,
                                      int index)
                               throws java.lang.ArrayIndexOutOfBoundsException
Helper method that encapsulates the procedure for replacing a specific Value in a ValueList with a new component created from a ValueList.
Parameters:
newValue - The ValueList used to construct the new Value.
index - The index of the ValueComponent to replace.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is not in the value list.


API Documentation Copyright © 1998-2003 Novell, Inc. All rights reserved.
ConsoleOne is a registered trademark of Novell Inc.
Generated December 9 2003 1727.