IlvGraphicVector (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.IlvGraphicVector

All Implemented Interfaces:

Serializable, Cloneable
```
public class IlvGraphicVector
extends Object
implements Cloneable, Serializable
```
An IlvGraphicVector is an expandable array of graphic objects. Note that the implementation is not synchronized. If multiple threads access an IlvGraphicVector concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`capacityIncrement` The size of the increment.
`static boolean`	`checkConcurrentModification` If this flag is true, the graphic vector throws concurrent modification exceptions if the vector is changed while enumerating its elements.
`static boolean`	`DEBUG` Allows you to debug ConcurrentModificationException thrown by IlvGraphicEnumeration.
`protected int`	`elementCount` The number of elements in the buffer.
`protected IlvGraphic[]`	`elementData` The buffer in which elements are stored.

Constructor Summary

Constructors
Constructor and Description
`IlvGraphicVector()` Constructs an empty vector.
`IlvGraphicVector(int initialCapacity)` Constructs an empty vector with the specified storage capacity.
`IlvGraphicVector(int initialCapacity, int capacityIncrement)` Constructs an empty vector with the specified storage capacity and the specified capacityIncrement.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(IlvGraphic object)` Adds the specified object as the last element of the vector.
`int`	`capacity()` Returns the current capacity of the vector.
`Object`	`clone()` Clones this vector.
`boolean`	`contains(IlvGraphic object)` Returns true if the specified element is a value of the vector.
`void`	`copyInto(IlvGraphic[] objects)` Copies the elements of this vector into the specified array.
`IlvGraphic`	`elementAt(int location)` Returns the element at the specified index.
`IlvGraphicEnumeration`	`elements()` Returns an enumeration of the elements.
`void`	`ensureCapacity(int minimumCapacity)` Ensures that the vector has at least the specified capacity.
`IlvGraphic`	`firstElement()` Returns the first element of the sequence.
`int`	`indexOf(IlvGraphic object)` Searches for the specified element starting from the first position.
`int`	`indexOf(IlvGraphic object, int location)` Searches for the specified element starting from the specified position.
`void`	`insertElementAt(IlvGraphic object, int location)` Inserts the specified object as an element at the specified index.
`boolean`	`isEmpty()` Returns the number of elements in the vector.
`IlvGraphic`	`lastElement()` Returns the last element of the sequence.
`int`	`lastIndexOf(IlvGraphic object)` Searches backwards for the specified element, starting from the last position.
`int`	`lastIndexOf(IlvGraphic object, int location)` Searches backwards for the specified element, starting from the specified position.
`void`	`removeAllElements()` Removes all elements of the vector.
`boolean`	`removeElement(IlvGraphic object)` Removes the element from the vector.
`void`	`removeElementAt(int location)` Deletes the element at the specified index.
`IlvGraphic`	`setElementAt(IlvGraphic object, int location)` Sets the element at the specified location to be the specified object.
`void`	`setSize(int length)` Sets the size of the vector.
`int`	`size()` Returns the number of elements in the vector.
`String`	`toString()` Returns a comma separated list of elements embraced in "[" and "]" as a String object.
`void`	`trimToSize()` Optimizes the capacity of the vector.

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

- Field Detail
  - capacityIncrement
```
protected int capacityIncrement
```
    The size of the increment.
  - checkConcurrentModification
```
public static boolean checkConcurrentModification
```
    If this flag is true, the graphic vector throws concurrent modification exceptions if the vector is changed while enumerating its elements.
    
    Since:
    
    JViews 8.5
  - DEBUG
```
public static boolean DEBUG
```
    Allows you to debug ConcurrentModificationException thrown by IlvGraphicEnumeration.
    
    Since:
    
    JViews 8.5
  - elementCount
```
protected int elementCount
```
    The number of elements in the buffer.
  - elementData
```
protected IlvGraphic[] elementData
```
    The buffer in which elements are stored.
- Constructor Detail
  - IlvGraphicVector
```
public IlvGraphicVector()
```
    Constructs an empty vector.
  - IlvGraphicVector
```
public IlvGraphicVector(int initialCapacity)
```
    Constructs an empty vector with the specified storage capacity.
    
    Parameters:
    
    initialCapacity - The initial storage capacity of the vector.
  - IlvGraphicVector
```
public IlvGraphicVector(int initialCapacity,
                        int capacityIncrement)
```
    Constructs an empty vector with the specified storage capacity and the specified capacityIncrement.
    
    Parameters:
    
    initialCapacity - The initial storage capacity of the vector.
    
    capacityIncrement - How much to increase the size of the element by.
- Method Detail
  - contains
```
public final boolean contains(IlvGraphic object)
```
    Returns true if the specified element is a value of the vector.
    
    Parameters:
    
    object - The desired element.
    
    Returns:
    
    Returns true if the specified element is in the vector.
    
    See Also:
    
    indexOf(IlvGraphic), indexOf(IlvGraphic, int)
  - isEmpty
```
public final boolean isEmpty()
```
    Returns the number of elements in the vector. Note that this is not the same as the capacity of the vector.
    
    Returns:
    
    The number of IlvGraphic objects in this vector.
    
    See Also:
    
    elementCount
  - removeElement
```
public boolean removeElement(IlvGraphic object)
```
    Removes the element from the vector. If the object occurs more than once, only the first occurrence is removed. If the object is not an element this method returns false.
    
    Parameters:
    
    object - The element to be removed.
    
    Returns:
    
    True if the element was successfully removed. Otherwise it returns false.
  - elementAt
```
public IlvGraphic elementAt(int location)
```
    Returns the element at the specified index.
    
    Parameters:
    
    location - The index of the desired element.
    
    Returns:
    
    The element at the specified index.
  - elements
```
public IlvGraphicEnumeration elements()
```
    Returns an enumeration of the elements. Use the Enumeration methods on the returned object to fetch the elements sequentially.
    
    Returns:
    
    An enumeration of the elements.
  - firstElement
```
public final IlvGraphic firstElement()
```
    Returns the first element of the sequence.
    
    Returns:
    
    The first element of the sequence.
    
    Throws:
    
    NoSuchElementException - If the sequence is empty.
    
    See Also:
    
    elementAt(int), lastElement(), size()
  - lastElement
```
public final IlvGraphic lastElement()
```
    Returns the last element of the sequence.
    
    Returns:
    
    The last element of the sequence.
    
    Throws:
    
    NoSuchElementException - If the sequence is empty.
    
    See Also:
    
    elementAt(int), firstElement(), size()
  - setElementAt
```
public final IlvGraphic setElementAt(IlvGraphic object,
                                     int location)
```
    Sets the element at the specified location to be the specified object. The previous element at that position is returned.
    
    Parameters:
    
    object - What the element is to be set to.
    
    location - The specified location
    
    Returns:
    
    The previous element at that position.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If the location was not valid.
    
    See Also:
    
    size()
  - capacity
```
public final int capacity()
```
    Returns the current capacity of the vector.
    
    Returns:
    
    The current capacity of the vector.
    
    See Also:
    
    ensureCapacity(int), size()
  - indexOf
```
public int indexOf(IlvGraphic object)
```
    Searches for the specified element starting from the first position. It returns an index to it.
    
    Parameters:
    
    object - The desired element.
    
    Returns:
    
    The index of the element, or -1 if it is not found.
    
    See Also:
    
    indexOf(IlvGraphic, int)
  - indexOf
```
public final int indexOf(IlvGraphic object,
                         int location)
```
    Searches for the specified element starting from the specified position. It returns the element index.
    
    Parameters:
    
    object - The desired element.
    
    location - The index where the search should be started.
    
    Returns:
    
    The index of the element, or -1 if it is not found.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If location is less than zero.
    
    See Also:
    
    indexOf(IlvGraphic)
  - lastIndexOf
```
public final int lastIndexOf(IlvGraphic object)
```
    Searches backwards for the specified element, starting from the last position. It returns the element index.
    
    Parameters:
    
    object - The desired element.
    
    Returns:
    
    The index of the element, or -1 if it is not found.
    
    See Also:
    
    contains(ilog.views.IlvGraphic), indexOf(IlvGraphic), indexOf(IlvGraphic, int), lastIndexOf(IlvGraphic, int)
  - lastIndexOf
```
public final int lastIndexOf(IlvGraphic object,
                             int location)
```
    Searches backwards for the specified element, starting from the specified position. It returns an location to the element.
    
    Parameters:
    
    object - The desired element.
    
    location - The location where the search should be started.
    
    Returns:
    
    The location of the element, or -1 if it is not found.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If location is greater than or equal to the size of the graphic vector.
    
    See Also:
    
    contains(ilog.views.IlvGraphic), indexOf(IlvGraphic), indexOf(IlvGraphic, int), lastIndexOf(IlvGraphic)
  - size
```
public final int size()
```
    Returns the number of elements in the vector. Note that this is not the same as the capacity of the vector.
    
    Returns:
    
    The number of elements in the vector
    
    See Also:
    
    elementCount, lastElement()
  - toString
```
public final String toString()
```
    Returns a comma separated list of elements embraced in "[" and "]" as a String object.
    
    Overrides:
    
    toString in class Object
  - addElement
```
public void addElement(IlvGraphic object)
```
    Adds the specified object as the last element of the vector.
    
    Parameters:
    
    object - The element to be added.
  - copyInto
```
public final void copyInto(IlvGraphic[] objects)
```
    Copies the elements of this vector into the specified array.
    
    Parameters:
    
    objects - The array which elements are copied into.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If passed array is not large enough to hold all elements in this Vector.
    
    See Also:
    
    clone()
  - ensureCapacity
```
public void ensureCapacity(int minimumCapacity)
```
    Ensures that the vector has at least the specified capacity.
    
    Parameters:
    
    minimumCapacity - The desired minimum capacity.
    
    See Also:
    
    capacity()
  - insertElementAt
```
public void insertElementAt(IlvGraphic object,
                            int location)
```
    Inserts the specified object as an element at the specified index. Elements with an index greater or equal to the current index are shifted up.
    
    Parameters:
    
    object - The element to be inserted.
    
    location - Where the new element should be inserted.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If the index was not valid.
    
    See Also:
    
    addElement(ilog.views.IlvGraphic), size()
  - removeAllElements
```
public final void removeAllElements()
```
    Removes all elements of the vector. The vector becomes empty.
  - removeElementAt
```
public void removeElementAt(int location)
```
    Deletes the element at the specified index. Elements with an index greater than the current index are moved down.
    
    Parameters:
    
    location - The location of the element to be removed.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - If the index was not valid.
  - setSize
```
public final void setSize(int length)
```
    Sets the size of the vector. If the size shrinks, the extra elements (at the end of the vector) are lost. Whereas, if the size increases the new elements are set to null.
    
    Parameters:
    
    length - The new vector size.
  - trimToSize
```
public final void trimToSize()
```
    Optimizes the capacity of the vector. Use this operation to minimize the storage of a vector. Subsequent insertions will cause reallocation.
    
    See Also:
    
    capacity(), ensureCapacity(int), size()
  - clone
```
public Object clone()
```
    Clones this vector. The elements are not cloned.
    
    Overrides:
    
    clone in class Object

Class IlvGraphicVector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

capacityIncrement

checkConcurrentModification

DEBUG

elementCount

elementData

Constructor Detail

IlvGraphicVector

IlvGraphicVector

IlvGraphicVector

Method Detail

contains

isEmpty

removeElement

elementAt

elements

firstElement

lastElement

setElementAt

capacity

indexOf

indexOf

lastIndexOf

lastIndexOf

size

toString

addElement

copyInto

ensureCapacity

insertElementAt

removeAllElements

removeElementAt

setSize

trimToSize

clone