railo.runtime.type
Interface Array

All Superinterfaces:
Castable, Cloneable, Collection, Dumpable, Iteratorable, Serializable
All Known Subinterfaces:
Argument, ArgumentPro
All Known Implementing Classes:
ArgumentImpl, ArgumentThreadImpl, ArrayImpl, ArrayImplNS, ArraySupport, CastableArray, ListAsArray, SVArray, TOArray, XMLMultiElementArray, XMLNodeList

public interface Array
extends Collection, Cloneable


Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Method Summary
 Object append(Object o)
          append a new value to the end of the array
 Object appendEL(Object o)
           
 boolean containsKey(int key)
          contains this key
 Object get(int key, Object defaultValue)
          return object a given position, key can only be a integer from 1 to array len
 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 key, Object value)
          insert a value add defined position
 int[] intKeys()
           
 Object prepend(Object o)
          add a new value to the begin of the array
 Object removeE(int key)
          removes a value ad defined key
 Object removeEL(int key)
          removes a value ad defined key
 void resize(int to)
          resize array to defined size
 Object setE(int key, Object value)
          set value at defined position
 Object setEL(int key, Object value)
          set value at defined position, on error return null
 void sort(String sortType, String sortOrder)
          sort values of a array
 Object[] toArray()
           
 List toList()
           
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, keysAsString, remove, removeEL, set, set, setEL, setEL, size
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 
Methods inherited from interface railo.runtime.type.Iteratorable
iterator, keyIterator, valueIterator
 
Methods inherited from interface railo.runtime.op.Castable
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo
 

Method Detail

getDimension

int getDimension()
return dimension of the array

Returns:
dimension of the array

get

Object get(int key,
           Object defaultValue)
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

Object getE(int key)
            throws PageException
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

setEL

Object setEL(int key,
             Object value)
set value at defined position, on error return null

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

setE

Object setE(int key,
            Object value)
            throws PageException
set value at defined position

Parameters:
key -
value -
Returns:
defined value
Throws:
PageException

intKeys

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

insert

boolean insert(int key,
               Object value)
               throws PageException
insert a value add defined position

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

append

Object append(Object o)
              throws PageException
append a new value to the end of the array

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

appendEL

Object appendEL(Object o)

prepend

Object prepend(Object o)
               throws PageException
add a new value to the begin of the array

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

resize

void resize(int to)
            throws PageException
resize array to defined size

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

sort

void sort(String sortType,
          String sortOrder)
          throws PageException
sort values of a array

Parameters:
sortType - search type (text,textnocase,numeric)
sortOrder - (asc,desc)
Throws:
PageException

toArray

Object[] toArray()
Returns:
return arra as native (Java) Object Array

toList

List toList()
Returns:
return array as ArrayList

removeE

Object removeE(int key)
               throws PageException
removes a value ad defined key

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

removeEL

Object removeEL(int key)
removes a value ad defined key

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

containsKey

boolean containsKey(int key)
contains this key

Parameters:
key -
Returns:
returns if collection has a key with given name


Copyright © 2012 Railo