Package com.helger.regrep.rim

Class MapType

java.lang.Object

com.helger.regrep.rim.MapType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class MapType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

Represents a map that has a collection of entries (key/value pairs) where each entry is represented by EntryType instances

Java class for MapType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="MapType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Entry" type="{urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0}EntryType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

This class was annotated by ph-jaxb-plugin -Xph-annotate

This class contains methods created by ph-jaxb-plugin -Xph-equalshashcode

This class contains methods created by ph-jaxb-plugin -Xph-tostring

This class contains methods created by ph-jaxb-plugin -Xph-list-extension

This class contains methods created by ph-jaxb-plugin -Xph-cloneable2

This class contains methods created by ph-jaxb-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MapType()	Default constructor Note: automatically created by ph-jaxb-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method	Description
void	addEntry(EntryType elem)	Created by ph-jaxb-plugin -Xph-list-extension
MapType	clone()	Created by ph-jaxb-plugin -Xph-cloneable2
void	cloneTo(MapType ret)	This method clones all values from this to the passed object.
boolean	equals(Object o)	Created by ph-jaxb-plugin -Xph-equalshashcode
List<EntryType>	getEntry()	Gets the value of the entry property.
EntryType	getEntryAtIndex(int index)	Created by ph-jaxb-plugin -Xph-list-extension
int	getEntryCount()	Created by ph-jaxb-plugin -Xph-list-extension
boolean	hasEntryEntries()	Created by ph-jaxb-plugin -Xph-list-extension
int	hashCode()	Created by ph-jaxb-plugin -Xph-equalshashcode
boolean	hasNoEntryEntries()	Created by ph-jaxb-plugin -Xph-list-extension
void	setEntry(List<EntryType> aList)	Created by ph-jaxb-plugin -Xph-list-extension
String	toString()	Created by ph-jaxb-plugin -Xph-tostring

Methods inherited from class java.lang.Object

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

Constructor Detail

MapType

public MapType()

Default constructor
Note: automatically created by ph-jaxb-plugin -Xph-value-extender

Method Detail

getEntry

@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<EntryType> getEntry()

Gets the value of the entry property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the entry property.

For example, to add a new item, do as follows:

    getEntry().add(newItem);
 

Objects of the following type(s) are allowed in the list EntryType

Returns:

The value of the entry property.

equals

public boolean equals(Object o)

Created by ph-jaxb-plugin -Xph-equalshashcode

Overrides:

equals in class Object

hashCode

public int hashCode()

Created by ph-jaxb-plugin -Xph-equalshashcode

Overrides:

hashCode in class Object

toString

public String toString()

Created by ph-jaxb-plugin -Xph-tostring

Overrides:

toString in class Object

setEntry

public void setEntry(@Nullable
                     List<EntryType> aList)

Created by ph-jaxb-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasEntryEntries

public boolean hasEntryEntries()

Created by ph-jaxb-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoEntryEntries

public boolean hasNoEntryEntries()

Created by ph-jaxb-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getEntryCount

@Nonnegative
public int getEntryCount()

Created by ph-jaxb-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getEntryAtIndex

@Nullable
public EntryType getEntryAtIndex(@Nonnegative
                                 int index)
                          throws IndexOutOfBoundsException

Created by ph-jaxb-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addEntry

public void addEntry(@Nonnull
                     EntryType elem)

Created by ph-jaxb-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    MapType ret)

This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb-plugin -Xph-cloneable2

Parameters:

ret - The target object to clone to. May not be null.

clone

@Nonnull
@ReturnsMutableCopy
public MapType clone()

Created by ph-jaxb-plugin -Xph-cloneable2

Specified by:

clone in interface com.helger.commons.lang.IExplicitlyCloneable

Overrides:

clone in class Object

Returns:

The cloned object. Never null.