org.apache.empire.commons
Class Options

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractSet<OptionEntry>
          extended by org.apache.empire.commons.Options
All Implemented Interfaces:
java.lang.Iterable<OptionEntry>, java.util.Collection<OptionEntry>, java.util.Set<OptionEntry>

public class Options
extends java.util.AbstractSet<OptionEntry>

This class represents a list of possible values that are valid for a particular field.
Additionally the class provides a text string describing the value for display purposes.
The class is implemented as a set of OptionEntry objects where the entry value is used as the key for the set and thus must be unique.


Nested Class Summary
static class Options.InsertPos
           
 
Constructor Summary
Options()
           
Options(OptionEntry[] entries)
           
Options(Options other)
           
 
Method Summary
 void add(java.lang.Object value, java.lang.String text, boolean noCheck)
           
 boolean add(OptionEntry option)
           
 void addXml(org.w3c.dom.Element element, long flags)
           
 void clear()
           
 boolean contains(java.lang.Object object)
           
 boolean containsValue(java.lang.Object object)
           
 java.lang.String get(java.lang.Object value)
           
 OptionEntry getEntry(java.lang.Object value)
           
 java.lang.String getTextAt(int i)
           
 java.lang.Object getValueAt(int i)
           
 java.util.Set<java.lang.Object> getValues()
           
 boolean isEmpty()
           
 java.util.Iterator<OptionEntry> iterator()
           
 boolean remove(java.lang.Object object)
           
 void set(java.lang.Object value, java.lang.String text)
           
 void set(java.lang.Object value, java.lang.String text, Options.InsertPos pos)
           
 int size()
           
 java.lang.Object[] toArray()
           
 
Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll
 
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
addAll, containsAll, retainAll, toArray
 

Constructor Detail

Options

public Options()

Options

public Options(Options other)

Options

public Options(OptionEntry[] entries)
Method Detail

getEntry

public OptionEntry getEntry(java.lang.Object value)

get

public java.lang.String get(java.lang.Object value)

getValueAt

public java.lang.Object getValueAt(int i)

getTextAt

public java.lang.String getTextAt(int i)

getValues

public java.util.Set<java.lang.Object> getValues()

set

public void set(java.lang.Object value,
                java.lang.String text,
                Options.InsertPos pos)

set

public void set(java.lang.Object value,
                java.lang.String text)

add

public void add(java.lang.Object value,
                java.lang.String text,
                boolean noCheck)

add

public boolean add(OptionEntry option)
Specified by:
add in interface java.util.Collection<OptionEntry>
Specified by:
add in interface java.util.Set<OptionEntry>
Overrides:
add in class java.util.AbstractCollection<OptionEntry>

clear

public void clear()
Specified by:
clear in interface java.util.Collection<OptionEntry>
Specified by:
clear in interface java.util.Set<OptionEntry>
Overrides:
clear in class java.util.AbstractCollection<OptionEntry>

contains

public boolean contains(java.lang.Object object)
Specified by:
contains in interface java.util.Collection<OptionEntry>
Specified by:
contains in interface java.util.Set<OptionEntry>
Overrides:
contains in class java.util.AbstractCollection<OptionEntry>

containsValue

public boolean containsValue(java.lang.Object object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<OptionEntry>
Specified by:
isEmpty in interface java.util.Set<OptionEntry>
Overrides:
isEmpty in class java.util.AbstractCollection<OptionEntry>

iterator

public java.util.Iterator<OptionEntry> iterator()
Specified by:
iterator in interface java.lang.Iterable<OptionEntry>
Specified by:
iterator in interface java.util.Collection<OptionEntry>
Specified by:
iterator in interface java.util.Set<OptionEntry>
Specified by:
iterator in class java.util.AbstractCollection<OptionEntry>

remove

public boolean remove(java.lang.Object object)
Specified by:
remove in interface java.util.Collection<OptionEntry>
Specified by:
remove in interface java.util.Set<OptionEntry>
Overrides:
remove in class java.util.AbstractCollection<OptionEntry>

size

public int size()
Specified by:
size in interface java.util.Collection<OptionEntry>
Specified by:
size in interface java.util.Set<OptionEntry>
Specified by:
size in class java.util.AbstractCollection<OptionEntry>

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection<OptionEntry>
Specified by:
toArray in interface java.util.Set<OptionEntry>
Overrides:
toArray in class java.util.AbstractCollection<OptionEntry>

addXml

public void addXml(org.w3c.dom.Element element,
                   long flags)