ResultListBase (Commons Scaffold 1.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.scaffold.util
Class ResultListBase

java.lang.Object
  org.apache.commons.scaffold.util.ResultListBase

All Implemented Interfaces:: Iterable, Collection, ResultList

public class ResultListBase
extends Object
implements ResultList
extends Object
implements ResultList

Concrete implementation of ResultList.

Version:: $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $
Author:: Ted Husted

Field Summary
`protected Map`	`displayName` The displayName map, if any.
`protected List`	`result` The result list [ArrayList].
`protected Scroller`	`scroller` Our scroller object for paging through lists.

Constructor Summary
`ResultListBase()` Default constructor.
`ResultListBase(Collection c)` Convenience constructor to populate result with a Collection.
`ResultListBase(Object o)` Convenience constructor to populate result with an element.

Method Summary
`boolean`	`add(Object o)` Appends the specified element to the end of this list (optional operation).
`boolean`	`addAll(Collection c)` Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
`void`	`clear()` Removes all of the elements from this list..
`boolean`	`contains(Object element)` Returns true if this collection contains the specified element.
`boolean`	`containsAll(Collection c)` Returns true if this collection contains all of the elements in the specified collection.
`Object`	`get(int index)` Returns the element at the specified position in this list.
`Integer`	`getCode()` Return the code.
`int`	`getCounter()` Convenience method for maintaining a counter that can be shared among multiple components in some presentation systems (e.g, Tiles).
`Map`	`getDisplayName()` Return the displayName map (a HashMap).
`Object`	`getElement(int index)` Convenience accessor for `get()`.
`Iterator`	`getIterator()` Convenience accessor for `iterator()`.
`String`	`getLegend()` Return the legend.
`List`	`getResult()` Return the result list
`Scroller`	`getScroller()` Return our scroller.
`int`	`getSize()` Convenience accessor for `size()`.
`boolean`	`isEmpty()` Returns true if this collection contains no elements.
`Iterator`	`iterator()` Return an iterator for the List.
`boolean`	`populate(Object o, int index)` Populate matching properties on given object, using bean at given index.
`boolean`	`remove(Object o)` Removes a single instance of the specified element from this collection, if it is present (optional operation).
`boolean`	`removeAll(Collection c)` Removes all this collection's elements that are also contained in the specified collection.
`boolean`	`retainAll(Collection c)` Retains only the elements in this collection that are contained in the specified collection.
`void`	`setCode(Integer code)` Set the code.
`void`	`setCounter(int counter)` Set a new counter value.
`void`	`setDisplayName(Map displayName)` Assign a new displayName list.
`void`	`setLegend(String legend)` Set the legend.
`void`	`setLegend(String name, String value)` Set the legend.
`void`	`setResult(List result)` Set our result
`void`	`setScroller(Scroller scroller)` Set our scroller.
`int`	`size()` Return the number of elements on the List.
`Object[]`	`toArray()` Returns an array containing all of the elements in this collection.
`Object[]`	`toArray(Object[] a)` Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

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

Methods inherited from interface java.util.Collection
`equals, hashCode`

Field Detail

result

protected List result

The result list [ArrayList].

scroller

protected Scroller scroller

Our scroller object for paging through lists.

displayName

protected Map displayName

The displayName map, if any.

Constructor Detail

ResultListBase

public ResultListBase()

Default constructor.

ResultListBase

public ResultListBase(Object o)

Convenience constructor to populate result with an element.

ResultListBase

public ResultListBase(Collection c)

Convenience constructor to populate result with a Collection.

Method Detail