com.exalead.papi.helper

Class PartContainer

java.lang.Object

com.exalead.papi.helper.PartContainer

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Part>

public class PartContainer
extends java.lang.Object
implements java.lang.Iterable<Part>, java.io.Serializable

Container for parts.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<Part>	partList Underlying parts.

Constructor Summary

Constructors

Constructor and Description
PartContainer() Basic constructor which initializes an empty part container.

Method Summary

Modifier and Type	Method and Description
void	addPart(Part newPart) Add a new part.
void	addPart(java.lang.String partName, byte[] partData) Add a new part specifying the part name and an array of bytes for the part content.
boolean	equals(java.lang.Object obj) Helper function to compare with another object.
java.util.List<Part>	getList() Get the underlying list of parts.
int	hashCode()
protected boolean	isPartExists(Part testPart) Check if a part exists.
protected boolean	isPartExit(Part testPart) Deprecated. since V6R2015x, replaced by isPartExists(Part)
java.util.Iterator<Part>	iterator() Gets an iterator over the contained parts.
java.lang.String	toString() Simple part container serializer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

partList

protected java.util.ArrayList<Part> partList

Underlying parts.

Constructor Detail

PartContainer

public PartContainer()

Basic constructor which initializes an empty part container.

Method Detail

iterator

public java.util.Iterator<Part> iterator()

Gets an iterator over the contained parts.

Specified by:

iterator in interface java.lang.Iterable<Part>

Returns:

an iterator over the contained parts.

isPartExists

protected boolean isPartExists(Part testPart)

Check if a part exists.

Parameters:

testPart -

Returns:

true if a part exists, false otherwise.

isPartExit

@Deprecated
protected boolean isPartExit(Part testPart)

Deprecated. since V6R2015x, replaced by isPartExists(Part)

Check if a part exists.

Parameters:

testPart -

Returns:

true if a part exists, false otherwise.

addPart

public void addPart(Part newPart)

Add a new part.

Parameters:

newPart - Part to add.

addPart

public void addPart(java.lang.String partName,
                    byte[] partData)

Add a new part specifying the part name and an array of bytes for the part content.

Parameters:

partName - Part name.

partData - Part data.

getList

public java.util.List<Part> getList()

Get the underlying list of parts.

Returns:

the underlying list of parts.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Helper function to compare with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared.

Returns:

true if the object if a part container and if it contains the same list of parts, false otherwise.

toString

public java.lang.String toString()

Simple part container serializer.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the part.