org.unece.cefact.namespaces.sbdh.BusinessScope Maven / Gradle / Ivy
package org.unece.cefact.namespaces.sbdh;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import com.helger.commons.annotation.CodingStyleguideUnaware;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.lang.IExplicitlyCloneable;
import com.helger.commons.string.ToStringGenerator;
/**
* Java class for BusinessScope complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="BusinessScope">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="Scope" type="{http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader}Scope" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
* This class was annotated by ph-jaxb22-plugin -Xph-annotate
* This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode
* This class contains methods created by ph-jaxb22-plugin -Xph-tostring
* This class contains methods created by ph-jaxb22-plugin -Xph-list-extension
* This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2
* This class contains methods created by ph-jaxb22-plugin -Xph-value-extender
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "BusinessScope", propOrder = {
"scope"
})
@CodingStyleguideUnaware
public class BusinessScope implements Serializable, IExplicitlyCloneable
{
@XmlElement(name = "Scope")
private List scope;
/**
* Default constructor
* Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
*
*/
public BusinessScope() {
}
/**
* Gets the value of the scope 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 JAXB object.
* This is why there is not a set method for the scope property.
*
*
* For example, to add a new item, do as follows:
*
* getScope().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Scope }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getScope() {
if (scope == null) {
scope = new ArrayList();
}
return this.scope;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if ((o == null)||(!getClass().equals(o.getClass()))) {
return false;
}
final BusinessScope rhs = ((BusinessScope) o);
if (!EqualsHelper.equalsCollection(scope, rhs.scope)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(scope).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("scope", scope).getToString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setScope(
@Nullable
final List aList) {
scope = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasScopeEntries() {
return (!getScope().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoScopeEntries() {
return getScope().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getScopeCount() {
return getScope().size();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws IndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public Scope getScopeAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getScope().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addScope(
@Nonnull
final Scope elem) {
getScope().add(elem);
}
/**
* This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @param ret
* The target object to clone to. May not be null.
*/
public void cloneTo(
@Nonnull
BusinessScope ret) {
if (scope == null) {
ret.scope = null;
} else {
List retScope = new ArrayList();
for (Scope aItem: getScope()) {
retScope.add(((aItem == null)?null:aItem.clone()));
}
ret.scope = retScope;
}
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public BusinessScope clone() {
BusinessScope ret = new BusinessScope();
cloneTo(ret);
return ret;
}
}