com.anaptecs.jeaf.junit.pojo.BidirectionalB Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.jeaf.junit.pojo;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import javax.annotation.Generated;
import javax.validation.ConstraintViolationException;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;
@Generated("com.anaptecs.jeaf.generator.JEAFGenerator")
@SuppressWarnings("JEAF_SUPPRESS_WARNINGS")
@JsonIgnoreProperties(ignoreUnknown = true)
public class BidirectionalB {
/**
* Constant for the name of attribute "as".
*/
public static final String AS = "as";
/**
* Constant for the name of attribute "theAs".
*/
public static final String THEAS = "theAs";
@JsonSetter(nulls = Nulls.SKIP)
private List as;
/**
* Attribute is required for correct handling of bidirectional associations in case of deserialization.
*/
private transient boolean asBackReferenceInitialized;
@JsonSetter(nulls = Nulls.SKIP)
private List theAs;
/**
* Attribute is required for correct handling of bidirectional associations in case of deserialization.
*/
private transient boolean theAsBackReferenceInitialized;
/**
* Default constructor is only intended to be used for deserialization by tools like Jackson for JSON. For "normal"
* object creation builder should be used instead.
*/
protected BidirectionalB( ) {
as = new ArrayList();
// Bidirectional back reference is not yet set up correctly
asBackReferenceInitialized = false;
theAs = new ArrayList();
// Bidirectional back reference is not yet set up correctly
theAsBackReferenceInitialized = false;
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected BidirectionalB( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
if (pBuilder.as != null) {
as = pBuilder.as;
}
else {
as = new ArrayList();
}
// Bidirectional back reference is set up correctly as a builder is used.
asBackReferenceInitialized = true;
if (pBuilder.theAs != null) {
theAs = pBuilder.theAs;
}
else {
theAs = new ArrayList();
}
// Bidirectional back reference is set up correctly as a builder is used.
theAsBackReferenceInitialized = true;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new BidirectionalB objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Method creates a new builder and initializes it with the data from the passed object.
*
* @param pObject Object that should be used to initialize the builder. The parameter may be null.
* @return {@link Builder} New builder that can be used to create new BidirectionalB objects. The method never returns
* null.
* @deprecated Please use {@link #toBuilder()} instead.
*/
@Deprecated
public static Builder builder( BidirectionalB pObject ) {
return new Builder(pObject);
}
/**
* Convenience method to create new instance of class BidirectionalB.
*
*
* @return {@link BidirectionalB}
*/
public static BidirectionalB of( ) {
BidirectionalB.Builder lBuilder = BidirectionalB.builder();
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class BidirectionalB.
*/
public static class Builder {
private List as;
private List theAs;
/**
* Use {@link BidirectionalB#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link BidirectionalB#builder(BidirectionalB)} instead of private constructor to create new builder.
*/
protected Builder( BidirectionalB pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setAs(pObject.as);
this.setTheAs(pObject.theAs);
}
}
/**
* Method sets association {@link #as}.
*
* @param pAs Collection to which {@link #as} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setAs( List pAs ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pAs != null) {
as = new ArrayList(pAs);
}
else {
as = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #as}.
*
* @param pAs Array of objects that should be added to {@link #as}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToAs( BidirectionalA... pAs ) {
if (pAs != null) {
if (as == null) {
as = new ArrayList();
}
as.addAll(Arrays.asList(pAs));
}
return this;
}
/**
* Method sets association {@link #theAs}.
*
* @param pTheAs Collection to which {@link #theAs} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setTheAs( List pTheAs ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pTheAs != null) {
theAs = new ArrayList(pTheAs);
}
else {
theAs = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #theAs}.
*
* @param pTheAs Array of objects that should be added to {@link #theAs}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToTheAs( BidirectionalA... pTheAs ) {
if (pTheAs != null) {
if (theAs == null) {
theAs = new ArrayList();
}
theAs.addAll(Arrays.asList(pTheAs));
}
return this;
}
/**
* Method creates a new instance of class BidirectionalB. The object will be initialized with the values of the
* builder.
*
* @return BidirectionalB Created object. The method never returns null.
*/
public BidirectionalB build( ) {
return new BidirectionalB(this);
}
/**
* Method creates a new validated instance of class BidirectionalB. The object will be initialized with the values
* of the builder and validated afterwards.
*
* @return BidirectionalB Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public BidirectionalB buildValidated( ) throws ConstraintViolationException {
BidirectionalB lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns association {@link #as}.
*
* @return {@link List} Value to which {@link #as} is set. The method never returns null and the
* returned collection is unmodifiable.
*/
public List getAs( ) {
// Due to restrictions in JSON serialization / deserialization bi-directional associations need a special handling
// after an object was deserialized.
if (asBackReferenceInitialized == false) {
asBackReferenceInitialized = true;
for (BidirectionalA lNext : as) {
lNext.setTransientB((BidirectionalB) this);
}
}
// Return all BidirectionalA objects as unmodifiable collection.
return Collections.unmodifiableList(as);
}
/**
* Method adds the passed object to {@link #as}.
*
* @param pAs Object that should be added to {@link #as}. The parameter must not be null.
*/
public void addToAs( BidirectionalA pAs ) {
// Check parameter "pAs" for invalid value null.
Check.checkInvalidParameterNull(pAs, "pAs");
// Since this is not a many-to-many association the association to which the passed object belongs, has to
// be released.
pAs.unsetTransientB();
// Add passed object to collection of associated BidirectionalA objects.
as.add(pAs);
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
if (pAs != null && this.equals(pAs.getTransientB()) == false) {
pAs.setTransientB((BidirectionalB) this);
}
}
/**
* Method adds all passed objects to {@link #as}.
*
* @param pAs Collection with all objects that should be added to {@link #as}. The parameter must not be null.
*/
public void addToAs( Collection pAs ) {
// Check parameter "pAs" for invalid value null.
Check.checkInvalidParameterNull(pAs, "pAs");
// Add all passed objects.
for (BidirectionalA lNextObject : pAs) {
this.addToAs(lNextObject);
}
}
/**
* Method removes the passed object from {@link #as}.
*
* @param pAs Object that should be removed from {@link #as}. The parameter must not be null.
*/
public void removeFromAs( BidirectionalA pAs ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pAs, "pAs");
// Remove passed object from collection of associated BidirectionalA objects.
as.remove(pAs);
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
if (this.equals(pAs.getTransientB()) == true) {
pAs.unsetTransientB();
}
}
/**
* Method removes all objects from {@link #as}.
*/
public void clearAs( ) {
// Remove all objects from association "as".
Collection lAs = new HashSet(as);
Iterator lIterator = lAs.iterator();
while (lIterator.hasNext()) {
// As association is bidirectional we have to clear it in both directions.
this.removeFromAs(lIterator.next());
}
}
/**
* Method returns association {@link #theAs}.
*
* @return {@link List} Value to which {@link #theAs} is set. The method never returns null and the
* returned collection is unmodifiable.
*/
public List getTheAs( ) {
// Due to restrictions in JSON serialization / deserialization bi-directional associations need a special handling
// after an object was deserialized.
if (theAsBackReferenceInitialized == false) {
theAsBackReferenceInitialized = true;
for (BidirectionalA lNext : theAs) {
lNext.addToTransientBs((BidirectionalB) this);
}
}
// Return all BidirectionalA objects as unmodifiable collection.
return Collections.unmodifiableList(theAs);
}
/**
* Method adds the passed object to {@link #theAs}.
*
* @param pTheAs Object that should be added to {@link #theAs}. The parameter must not be null.
*/
public void addToTheAs( BidirectionalA pTheAs ) {
// Check parameter "pTheAs" for invalid value null.
Check.checkInvalidParameterNull(pTheAs, "pTheAs");
// Add passed object to collection of associated BidirectionalA objects.
theAs.add(pTheAs);
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
if (pTheAs != null && pTheAs.getTransientBs().contains(this) == false) {
pTheAs.addToTransientBs((BidirectionalB) this);
}
}
/**
* Method adds all passed objects to {@link #theAs}.
*
* @param pTheAs Collection with all objects that should be added to {@link #theAs}. The parameter must not be null.
*/
public void addToTheAs( Collection pTheAs ) {
// Check parameter "pTheAs" for invalid value null.
Check.checkInvalidParameterNull(pTheAs, "pTheAs");
// Add all passed objects.
for (BidirectionalA lNextObject : pTheAs) {
this.addToTheAs(lNextObject);
}
}
/**
* Method removes the passed object from {@link #theAs}.
*
* @param pTheAs Object that should be removed from {@link #theAs}. The parameter must not be null.
*/
public void removeFromTheAs( BidirectionalA pTheAs ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pTheAs, "pTheAs");
// Remove passed object from collection of associated BidirectionalA objects.
theAs.remove(pTheAs);
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
if (pTheAs.getTransientBs().contains(this) == true) {
pTheAs.removeFromTransientBs((BidirectionalB) this);
}
}
/**
* Method removes all objects from {@link #theAs}.
*/
public void clearTheAs( ) {
// Remove all objects from association "theAs".
Collection lTheAs = new HashSet(theAs);
Iterator lIterator = lTheAs.iterator();
while (lIterator.hasNext()) {
// As association is bidirectional we have to clear it in both directions.
this.removeFromTheAs(lIterator.next());
}
}
/**
* Method returns a StringBuilder that can be used to create a String representation of this object. The returned
* StringBuilder also takes care about attributes of super classes.
*
* @return {@link StringBuilder} StringBuilder representing this object. The method never returns null.
*/
public StringBuilder toStringBuilder( String pIndent ) {
StringBuilder lBuilder = new StringBuilder();
lBuilder.append(pIndent);
lBuilder.append(this.getClass().getName());
lBuilder.append(System.lineSeparator());
return lBuilder;
}
/**
* Method creates a new String with the values of all attributes of this class. All references to other objects will
* be ignored.
*
* @return {@link String} String representation of this object. The method never returns null.
*/
@Override
public String toString( ) {
return this.toStringBuilder("").toString();
}
/**
* Method creates a new builder and initializes it with the data of this object.
*
* @return {@link Builder} New builder that can be used to create new BidirectionalB objects. The method never returns
* null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}