railo.runtime.text.xml.struct
Class XMLMultiElementArray

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList
          extended by railo.runtime.type.util.ArraySupport
              extended by railo.runtime.text.xml.struct.XMLMultiElementArray
All Implemented Interfaces:
Serializable, Cloneable, Iterable, Collection, List, Dumpable, Castable, Array, ForEachIteratorable, Iteratorable, Objects, Sizeable

public class XMLMultiElementArray
extends ArraySupport

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Field Summary
 
Fields inherited from class railo.runtime.type.util.ArraySupport
TYPE_BOOLEAN, TYPE_BYTE, TYPE_CHARACTER, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_LONG, TYPE_OBJECT, TYPE_SHORT, TYPE_STRING
 
Constructor Summary
XMLMultiElementArray(XMLMultiElementStruct struct)
           
 
Method Summary
 boolean add(Object o)
           
 Object append(Object o)
          append a new value to the end of the array
 Object appendEL(Object o)
           
 Boolean castToBoolean(Boolean defaultValue)
          cast the castable value to a boolean value
 boolean castToBooleanValue()
          cast the castable value to a boolean value
 DateTime castToDateTime()
          cast the castable value to a date time object
 DateTime castToDateTime(DateTime defaultValue)
          cast the castable value to a date time object
 double castToDoubleValue()
          cast the castable value to a double value
 double castToDoubleValue(double defaultValue)
          cast the castable value to a double value
 String castToString()
          cast the castable value to a string, other than the Method toString, this Method can throw a Exception
 String castToString(String defaultValue)
          cast the castable value to a string, return the default value, when the method is not castable
 void clear()
          clears the collection
 Object clone()
           
 int compareTo(boolean b)
           
 int compareTo(DateTime dt)
           
 int compareTo(double d)
           
 int compareTo(String str)
           
 boolean containsKey(Collection.Key key)
          contains this key
 boolean containsKey(int key)
          contains this key
 boolean containsKey(String key)
          contains this key
 Collection duplicate(boolean deepCopy)
           
 Iterator<Map.Entry<Collection.Key,Object>> entryIterator()
           
 Object get(Collection.Key key)
          return a value from the collection
 Object get(Collection.Key key, Object defaultValue)
          return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null
 Object get(int key, Object defaultValue)
          return object a given position, key can only be a integer from 1 to array len
 Object get(String key)
          return a value from the collection
 Object get(String key, Object defaultValue)
          return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null
 int getDimension()
          return dimension of the array
 Object getE(int key)
          return object a given position, key can only be a integer from 1 to array len
 boolean insert(int index, Object value)
          insert a value add defined position
 int[] intKeys()
           
 Iterator<Collection.Key> keyIterator()
           
 Collection.Key[] keys()
           
 Iterator<String> keysAsStringIterator()
           
 Object prepend(Object value)
          add a new value to the begin of the array
 Object remove(Collection.Key key)
          removes value from collection and return it when it exists, otherwise throws a exception
 Object removeE(int key)
          removes a value ad defined key
 Object removeEL(Collection.Key key)
          removes value from collection and return it when it exists, otherwise returns null
 Object removeEL(int key)
          removes a value ad defined key
 void resize(int to)
          resize array to defined size
 Object set(Collection.Key key, Object value)
          sets a value to the collection
 Object set(String key, Object value)
          sets a value to the collection
 Object setE(int key, Object value)
          set value at defined position
 Object setEL(Collection.Key key, Object value)
          sets a value to the collection, if key doesn't exist, dont throw a exception, returns null
 Object setEL(int key, Object value)
          set value at defined position, on error return null
 Object setEL(String key, Object value)
          sets a value to the collection, if key doesn't exist, dont throw a exception, returns null
 int size()
           
 long sizeOf()
          return the size of the object
 void sort(Comparator comp)
           
 void sort(String sortType, String sortOrder)
          sort values of a array
 Object[] toArray()
           
 ArrayList toArrayList()
           
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
          method to print out information to a object as HTML
 
Methods inherited from class railo.runtime.type.util.ArraySupport
add, addAll, call, callWithNamedValues, equals, get, get, get, getIterator, hashCode, remove, remove, removeAll, retainAll, set, set, setEL, toArray, toList, toString, valueIterator
 
Methods inherited from class java.util.AbstractList
addAll, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
addAll, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, subList
 

Constructor Detail

XMLMultiElementArray

public XMLMultiElementArray(XMLMultiElementStruct struct)
Method Detail

append

public Object append(Object o)
              throws PageException
Description copied from interface: Array
append a new value to the end of the array

Parameters:
o - value to insert
Returns:
inserted value
Throws:
PageException

appendEL

public Object appendEL(Object o)

containsKey

public boolean containsKey(int key)
Description copied from interface: Array
contains this key

Specified by:
containsKey in interface Array
Overrides:
containsKey in class ArraySupport
Returns:
returns if collection has a key with given name

get

public Object get(int key,
                  Object defaultValue)
Description copied from interface: Array
return object a given position, key can only be a integer from 1 to array len

Parameters:
key - key as integer
Returns:
value at key position

getE

public Object getE(int key)
            throws PageException
Description copied from interface: Array
return object a given position, key can only be a integer from 1 to array len

Parameters:
key - key as integer
Returns:
value at key position
Throws:
PageException

getDimension

public int getDimension()
Description copied from interface: Array
return dimension of the array

Returns:
dimension of the array

insert

public boolean insert(int index,
                      Object value)
               throws PageException
Description copied from interface: Array
insert a value add defined position

Parameters:
index - position to insert
value - value to insert
Returns:
has done or not
Throws:
PageException

intKeys

public int[] intKeys()
Returns:
return all array keys as int

prepend

public Object prepend(Object value)
               throws PageException
Description copied from interface: Array
add a new value to the begin of the array

Parameters:
value - value to insert
Returns:
inserted value
Throws:
PageException

removeE

public Object removeE(int key)
               throws PageException
Description copied from interface: Array
removes a value ad defined key

Parameters:
key - key to remove
Returns:
retuns if value is removed or not
Throws:
PageException

removeEL

public Object removeEL(int key)
Description copied from interface: Array
removes a value ad defined key

Parameters:
key - key to remove
Returns:
retuns if value is removed or not

resize

public void resize(int to)
            throws PageException
Description copied from interface: Array
resize array to defined size

Parameters:
to - new minimum size of the array
Throws:
PageException

setE

public Object setE(int key,
                   Object value)
            throws PageException
Description copied from interface: Array
set value at defined position

Returns:
defined value
Throws:
PageException

setEL

public Object setEL(int key,
                    Object value)
Description copied from interface: Array
set value at defined position, on error return null

Parameters:
key - key of the new value
value - value to set
Returns:
setted value

sort

public void sort(String sortType,
                 String sortOrder)
          throws PageException
Description copied from interface: Array
sort values of a array

Specified by:
sort in interface Array
Overrides:
sort in class ArraySupport
Parameters:
sortType - search type (text,textnocase,numeric)
sortOrder - (asc,desc)
Throws:
PageException

sort

public void sort(Comparator comp)
          throws PageException
Throws:
PageException

toArray

public Object[] toArray()
Specified by:
toArray in interface Collection
Specified by:
toArray in interface List
Specified by:
toArray in interface Array
Overrides:
toArray in class AbstractCollection
Returns:
return arra as native (Java) Object Array

toArrayList

public ArrayList toArrayList()

clear

public void clear()
Description copied from interface: Collection
clears the collection

Specified by:
clear in interface Collection
Specified by:
clear in interface List
Overrides:
clear in class AbstractList

containsKey

public boolean containsKey(String key)
Description copied from interface: Collection
contains this key

Overrides:
containsKey in class ArraySupport
Returns:
returns if collection has a key with given name

containsKey

public boolean containsKey(Collection.Key key)
Description copied from interface: Collection
contains this key

Overrides:
containsKey in class ArraySupport
Returns:
returns if collection has a key with given name

duplicate

public Collection duplicate(boolean deepCopy)

get

public Object get(String key)
           throws PageException
Description copied from interface: Collection
return a value from the collection

Parameters:
key - key of the value to get
Returns:
value on key position
Throws:
PageException

get

public Object get(Collection.Key key)
           throws PageException
Description copied from interface: Collection
return a value from the collection

Parameters:
key - key of the value to get must be lower case
Returns:
value on key position
Throws:
PageException

get

public Object get(String key,
                  Object defaultValue)
Description copied from interface: Collection
return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null

Parameters:
key - key of the value to get
Returns:
value on key position or null

get

public Object get(Collection.Key key,
                  Object defaultValue)
Description copied from interface: Collection
return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null

Parameters:
key - key of the value to get
Returns:
value on key position or null

keys

public Collection.Key[] keys()
Returns:
returns a string array of all keys in the collection

remove

public Object remove(Collection.Key key)
              throws PageException
Description copied from interface: Collection
removes value from collection and return it when it exists, otherwise throws a exception

Parameters:
key - key of the collection
Returns:
removed Object
Throws:
PageException

removeEL

public Object removeEL(Collection.Key key)
Description copied from interface: Collection
removes value from collection and return it when it exists, otherwise returns null

Parameters:
key - key of the collection
Returns:
removed Object

set

public Object set(String key,
                  Object value)
           throws PageException
Description copied from interface: Collection
sets a value to the collection

Parameters:
key - key of the new value
value - value to set
Returns:
value setted
Throws:
PageException

set

public Object set(Collection.Key key,
                  Object value)
           throws PageException
Description copied from interface: Collection
sets a value to the collection

Parameters:
key - key of the new value
value - value to set
Returns:
value setted
Throws:
PageException

setEL

public Object setEL(String key,
                    Object value)
Description copied from interface: Collection
sets a value to the collection, if key doesn't exist, dont throw a exception, returns null

Parameters:
key - key of the value to get
value - value to set
Returns:
value on key position or null

setEL

public Object setEL(Collection.Key key,
                    Object value)
Description copied from interface: Collection
sets a value to the collection, if key doesn't exist, dont throw a exception, returns null

Parameters:
key - key of the value to get
value - value to set
Returns:
value on key position or null

size

public int size()
Specified by:
size in interface Collection
Specified by:
size in interface List
Specified by:
size in class AbstractCollection
Returns:
the size of the collection

toDumpData

public DumpData toDumpData(PageContext pageContext,
                           int maxlevel,
                           DumpProperties dp)
Description copied from interface: Dumpable
method to print out information to a object as HTML

Returns:
HTML print out

keyIterator

public Iterator<Collection.Key> keyIterator()
Returns:
return a Iterator for Keys as Collection.Keys

keysAsStringIterator

public Iterator<String> keysAsStringIterator()
Returns:
return a Iterator for Keys as String

entryIterator

public Iterator<Map.Entry<Collection.Key,Object>> entryIterator()

castToBooleanValue

public boolean castToBooleanValue()
                           throws PageException
Description copied from interface: Castable
cast the castable value to a boolean value

Specified by:
castToBooleanValue in interface Castable
Overrides:
castToBooleanValue in class ArraySupport
Returns:
boolean Value representation of the Object
Throws:
PageException

castToBoolean

public Boolean castToBoolean(Boolean defaultValue)
Description copied from interface: Castable
cast the castable value to a boolean value

Specified by:
castToBoolean in interface Castable
Overrides:
castToBoolean in class ArraySupport
Returns:
boolean Value representation of the Object

castToDateTime

public DateTime castToDateTime()
                        throws PageException
Description copied from interface: Castable
cast the castable value to a date time object

Specified by:
castToDateTime in interface Castable
Overrides:
castToDateTime in class ArraySupport
Returns:
date time representation of the Object
Throws:
PageException

castToDateTime

public DateTime castToDateTime(DateTime defaultValue)
Description copied from interface: Castable
cast the castable value to a date time object

Specified by:
castToDateTime in interface Castable
Overrides:
castToDateTime in class ArraySupport
Parameters:
defaultValue - returned when it is not possible to cast to a dateTime object
Returns:
date time representation of the Object

castToDoubleValue

public double castToDoubleValue()
                         throws PageException
Description copied from interface: Castable
cast the castable value to a double value

Specified by:
castToDoubleValue in interface Castable
Overrides:
castToDoubleValue in class ArraySupport
Returns:
double Value representation of the Object
Throws:
PageException

castToDoubleValue

public double castToDoubleValue(double defaultValue)
Description copied from interface: Castable
cast the castable value to a double value

Specified by:
castToDoubleValue in interface Castable
Overrides:
castToDoubleValue in class ArraySupport
Returns:
double Value representation of the Object

castToString

public String castToString()
                    throws PageException
Description copied from interface: Castable
cast the castable value to a string, other than the Method toString, this Method can throw a Exception

Specified by:
castToString in interface Castable
Overrides:
castToString in class ArraySupport
Returns:
String representation of the Object
Throws:
PageException

castToString

public String castToString(String defaultValue)
Description copied from interface: Castable
cast the castable value to a string, return the default value, when the method is not castable

Specified by:
castToString in interface Castable
Overrides:
castToString in class ArraySupport
Returns:
String representation of the Object

compareTo

public int compareTo(String str)
              throws PageException
Specified by:
compareTo in interface Castable
Overrides:
compareTo in class ArraySupport
Throws:
PageException

compareTo

public int compareTo(boolean b)
              throws PageException
Specified by:
compareTo in interface Castable
Overrides:
compareTo in class ArraySupport
Throws:
PageException

compareTo

public int compareTo(double d)
              throws PageException
Specified by:
compareTo in interface Castable
Overrides:
compareTo in class ArraySupport
Throws:
PageException

compareTo

public int compareTo(DateTime dt)
              throws PageException
Specified by:
compareTo in interface Castable
Overrides:
compareTo in class ArraySupport
Throws:
PageException

clone

public Object clone()
Overrides:
clone in class ArraySupport
Returns:
this object cloned

add

public boolean add(Object o)
Specified by:
add in interface Collection
Specified by:
add in interface List
Overrides:
add in class AbstractList

sizeOf

public long sizeOf()
Description copied from interface: Sizeable
return the size of the object

Returns:
size of the object


Copyright © 2012 Railo