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.kemet.orm.castor
Class Items

    java.lang.Object
      org.kemet.orm.castor.Items

All Implemented Interfaces:
  java.io.Serializable

    public class Items

extends java.lang.Object
implements java.io.Serializable

Class Items.

Version:
  $Revision$ $Date$
See Also:
  Serialized Form

Constructor Summary
`Items()`

Method Summary
`void` | `addItem(int index, Item vItem)`
`void` | `addItem(Item vItem)`
`java.util.Enumeration` | `enumerateItem()` Method enumerateItem.
`Item[]` | `getItem()` Method getItem.Returns the contents of the collection in an Array.
`Item` | `getItem(int index)` Method getItem.
`int` | `getItemCount()` Method getItemCount.
`boolean` | `isValid()` Method isValid.
`java.util.Iterator` | `iterateItem()` Method iterateItem.
`void` | `marshal(org.xml.sax.ContentHandler handler)`
`void` | `marshal(java.io.Writer out)`
`void` | `removeAllItem()`
`boolean` | `removeItem(Item vItem)` Method removeItem.
`Item` | `removeItemAt(int index)` Method removeItemAt.
`void` | `setItem(int index, Item vItem)`
`void` | `setItem(Item[] vItemArray)`
`static Items` | `unmarshal(java.io.Reader reader)` Method unmarshal.
`void` | `validate()`

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

Constructor Detail

### Items

    public Items()

Method Detail

### addItem

    public void addItem(Item vItem)
                 throws java.lang.IndexOutOfBoundsException

  Parameters:
    `vItem` -
  Throws:
    `java.lang.IndexOutOfBoundsException` - if the index given is outside the bounds of the collection

### addItem

    public void addItem(int index,
                        Item vItem)
                 throws java.lang.IndexOutOfBoundsException

  Parameters:
    `index` -
    `vItem` -
  Throws:
    `java.lang.IndexOutOfBoundsException` - if the index given is outside the bounds of the collection

### enumerateItem

    public java.util.Enumeration enumerateItem()

  Method enumerateItem.

  Returns:
    an Enumeration over all possible elements of this collection

### getItem

    public Item getItem(int index)
                 throws java.lang.IndexOutOfBoundsException

  Method getItem.

  Parameters:
    `index` -
  Returns:
    the value of the org.kemet.orm.castor.Item at the given index
  Throws:
    `java.lang.IndexOutOfBoundsException` - if the index given is outside the bounds of the collection

### getItem

    public Item[] getItem()

  Method getItem.Returns the contents of the collection in an Array.

  Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

  Returns:
    this collection as an Array

### getItemCount

    public int getItemCount()

  Method getItemCount.

  Returns:
    the size of this collection

### isValid

    public boolean isValid()

  Method isValid.

  Returns:
    true if this object is valid according to the schema

### iterateItem

    public java.util.Iterator iterateItem()

  Method iterateItem.

  Returns:
    an Iterator over all possible elements in this collection

### marshal

    public void marshal(java.io.Writer out)
                 throws org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

  Parameters:
    `out` -
  Throws:
    `org.exolab.castor.xml.MarshalException` - if object is null or if any SAXException is thrown during marshaling
    `org.exolab.castor.xml.ValidationException` - if this object is an invalid instance according to the schema

### marshal

    public void marshal(org.xml.sax.ContentHandler handler)
                 throws java.io.IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

  Parameters:
    `handler` -
  Throws:
    `java.io.IOException` - if an IOException occurs during marshaling
    `org.exolab.castor.xml.ValidationException` - if this object is an invalid instance according to the schema
    `org.exolab.castor.xml.MarshalException` - if object is null or if any SAXException is thrown during marshaling

### removeAllItem

    public void removeAllItem()

### removeItem

    public boolean removeItem(Item vItem)

  Method removeItem.

  Parameters:
    `vItem` -
  Returns:
    true if the object was removed from the collection.

### removeItemAt

    public Item removeItemAt(int index)

  Method removeItemAt.

  Parameters:
    `index` -
  Returns:
    the element removed from the collection

### setItem

    public void setItem(int index,
                        Item vItem)
                 throws java.lang.IndexOutOfBoundsException

  Parameters:
    `index` -
    `vItem` -
  Throws:
    `java.lang.IndexOutOfBoundsException` - if the index given is outside the bounds of the collection

### setItem

    public void setItem(Item[] vItemArray)

  Parameters:
    `vItemArray` -

### unmarshal

    public static Items unmarshal(java.io.Reader reader)
                           throws org.exolab.castor.xml.MarshalException,
                                  org.exolab.castor.xml.ValidationException

  Method unmarshal.

  Parameters:
    `reader` -
  Returns:
    the unmarshaled org.kemet.orm.castor.Items
  Throws:
    `org.exolab.castor.xml.MarshalException` - if object is null or if any SAXException is thrown during marshaling
    `org.exolab.castor.xml.ValidationException` - if this object is an invalid instance according to the schema

### validate

    public void validate()
                  throws org.exolab.castor.xml.ValidationException

  Throws:
    `org.exolab.castor.xml.ValidationException` - if this object is an invalid instance according to the schema

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 F. MAUPIN. All Rights Reserved.