com.ptc.windchill.esi.rnd
Class VdbContainer

java.lang.Object
  com.ptc.windchill.esi.rnd.VdbContainer

All Implemented Interfaces:

Externalizable, Serializable

public final class VdbContainer

extends Object

implements Externalizable

Manages a collection of VdbGroups and renders them as an Info*Engine IeCollection.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private LinkedHashMap	groups
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private TaskHelper	taskHelper

Constructor Summary

VdbContainer()

VdbContainer(int initial_capacity)

Method Summary

void	addGroup(String name, VdbGroup group) Adds a VdbGroup to the groups collection.
IeCollection	asVDB() Returns the contents of the groups collection as an Info*Engine IeCollection.
VdbGroup	getGroup(String name) Returns a VdbGroup from the groups collection.
Collection	getGroups() Returns the contents of the groups collection.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(VdbContainer thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	removeGroup(String name) Removes a VdbGroup from the groups collection if one exists in the collection with a logical name that is equal to the argument.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

groups

private LinkedHashMap groups

taskHelper

private TaskHelper taskHelper

Constructor Detail

VdbContainer

public VdbContainer()

VdbContainer

public VdbContainer(int initial_capacity)

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(VdbContainer thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

addGroup

public void addGroup(String name,
                     VdbGroup group)
              throws MissingParameterException

Adds a VdbGroup to the groups collection. Uses the logical name of the group that is passed in the name argument.
Throws a MissingParameterException if either argument is null.

Supported API: true

Parameters:

name - The logical name of the group.

group - The VdbGroup to add to the groups collection.

Throws:

MissingParameterException

removeGroup

public void removeGroup(String name)

Removes a VdbGroup from the groups collection if one exists in the collection with a logical name that is equal to the argument.

Supported API: true

Parameters:

name - The logical name of the group to remove.

getGroup

public VdbGroup getGroup(String name)

Returns a VdbGroup from the groups collection. Returns null if the group with the supplied name is not found in the collection.

Supported API: true

Parameters:

name - The logical name of the group to obtain.

Returns:

VdbGroup

getGroups

public Collection getGroups()

Returns the contents of the groups collection.

Supported API: true

Returns:

Collection

asVDB

public IeCollection asVDB()

Returns the contents of the groups collection as an Info*Engine IeCollection.

Supported API: true

Returns:

IeCollection