com.groupdocs.assembly.system.data

Class ConstraintCollection

java.lang.Object

com.groupdocs.assembly.system.data.ConstraintCollection

All Implemented Interfaces:

java.lang.Iterable

public final class ConstraintCollection
extends java.lang.Object
implements java.lang.Iterable

Represents a collection of constraints for a DataTable.

Method Summary

Modifier and Type	Method and Description
void	add(Constraint constraint) Adds the specified Constraint object to the collection.
boolean	contains(Constraint cc) Indicates whether the Constraint object specified by name exists in the collection.
Constraint	get(int index) Gets the Constraint from the collection at the specified index.
Constraint	get(java.lang.String name) Gets the Constraint from the collection with the specified name.
int	getCount() Gets the total number of elements in a collection.
java.util.Iterator	iterator()
void	remove(Constraint constraint) Removes the specified Constraint from the collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

public final Constraint get(java.lang.String name)

Gets the Constraint from the collection with the specified name.

Parameters:

name - The Constraint.getConstraintName() / Constraint.setConstraintName(java.lang.String) of the constraint to return.

Returns:

The Constraint with the specified name; otherwise a null value if the Constraint does not exist.

get

public final Constraint get(int index)

Gets the Constraint from the collection at the specified index.

Parameters:

index - The index of the constraint to return.

Returns:

The Constraint at the specified index.

add

public final void add(Constraint constraint)
               throws DataException,
                      InvalidConstraintException

Adds the specified Constraint object to the collection.

Parameters:

constraint - The Constraint to add.

Throws:

DataException

InvalidConstraintException

remove

public final void remove(Constraint constraint)

Removes the specified Constraint from the collection.

Parameters:

constraint - The Constraint to remove.

contains

public final boolean contains(Constraint cc)

Indicates whether the Constraint object specified by name exists in the collection.

Parameters:

cc - The Constraint to remove.

Returns:

true if the collection contains the specified constraint; otherwise, false.

getCount

public final int getCount()

Gets the total number of elements in a collection.

Returns:

The total number of elements in a collection.

iterator

public final java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable