com.anaptecs.jeaf.junit.objectmapping.PrimitiveReferenceServiceObject Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.jeaf.junit.objectmapping;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import javax.validation.ConstraintViolationException;
import com.anaptecs.jeaf.core.api.ServiceObject;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
public class PrimitiveReferenceServiceObject implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
/**
* Constant for the name of attribute "aBoolean".
*/
public static final String ABOOLEAN = "aBoolean";
/**
* Constant for the name of attribute "booleanSet".
*/
public static final String BOOLEANSET = "booleanSet";
/**
* Constant for the name of attribute "buffers".
*/
public static final String BUFFERS = "buffers";
/**
* Constant for the name of attribute "strings".
*/
public static final String STRINGS = "strings";
/**
* Constant for the name of attribute "stringArray".
*/
public static final String STRINGARRAY = "stringArray";
private Boolean aBoolean;
private Set booleanSet;
private Set buffers;
private Set strings;
private Set stringArray;
/**
* 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 PrimitiveReferenceServiceObject( ) {
booleanSet = new HashSet();
buffers = new HashSet();
strings = new HashSet();
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected PrimitiveReferenceServiceObject( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
aBoolean = pBuilder.aBoolean;
if (pBuilder.booleanSet != null) {
booleanSet = pBuilder.booleanSet;
}
else {
booleanSet = new HashSet();
}
if (pBuilder.buffers != null) {
buffers = pBuilder.buffers;
}
else {
buffers = new HashSet();
}
if (pBuilder.strings != null) {
strings = pBuilder.strings;
}
else {
strings = new HashSet();
}
stringArray = pBuilder.stringArray;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new PrimitiveReferenceServiceObject objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class PrimitiveReferenceServiceObject.
*
*
* @return {@link com.anaptecs.jeaf.junit.objectmapping.PrimitiveReferenceServiceObject}
*/
public static PrimitiveReferenceServiceObject of( ) {
PrimitiveReferenceServiceObject.Builder lBuilder = PrimitiveReferenceServiceObject.builder();
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class PrimitiveReferenceServiceObject.
*/
public static class Builder {
private Boolean aBoolean;
private Set booleanSet;
private Set buffers;
private Set strings;
private Set stringArray;
/**
* Use {@link PrimitiveReferenceServiceObject#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link PrimitiveReferenceServiceObject#builder(PrimitiveReferenceServiceObject)} instead of private
* constructor to create new builder.
*/
protected Builder( PrimitiveReferenceServiceObject pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setABoolean(pObject.aBoolean);
this.setBooleanSet(pObject.booleanSet);
this.setBuffers(pObject.buffers);
this.setStrings(pObject.strings);
this.setStringArray(pObject.stringArray);
}
}
/**
* Method sets association {@link #aBoolean}.
*
* @param pABoolean Value to which {@link #aBoolean} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setABoolean( Boolean pABoolean ) {
aBoolean = pABoolean;
return this;
}
/**
* Method sets association {@link #booleanSet}.
*
* @param pBooleanSet Collection to which {@link #booleanSet} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setBooleanSet( Set pBooleanSet ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pBooleanSet != null) {
booleanSet = new HashSet(pBooleanSet);
}
else {
booleanSet = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #booleanSet}.
*
* @param pBooleanSet Array of objects that should be added to {@link #booleanSet}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToBooleanSet( Boolean... pBooleanSet ) {
if (pBooleanSet != null) {
if (booleanSet == null) {
booleanSet = new HashSet();
}
booleanSet.addAll(Arrays.asList(pBooleanSet));
}
return this;
}
/**
* Method sets association {@link #buffers}.
*
* @param pBuffers Collection to which {@link #buffers} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setBuffers( Set pBuffers ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pBuffers != null) {
buffers = new HashSet(pBuffers);
}
else {
buffers = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #buffers}.
*
* @param pBuffers Array of objects that should be added to {@link #buffers}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToBuffers( StringBuffer... pBuffers ) {
if (pBuffers != null) {
if (buffers == null) {
buffers = new HashSet();
}
buffers.addAll(Arrays.asList(pBuffers));
}
return this;
}
/**
* Method sets association {@link #strings}.
*
* @param pStrings Collection to which {@link #strings} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setStrings( Set pStrings ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pStrings != null) {
strings = new HashSet(pStrings);
}
else {
strings = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #strings}.
*
* @param pStrings Array of objects that should be added to {@link #strings}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToStrings( String... pStrings ) {
if (pStrings != null) {
if (strings == null) {
strings = new HashSet();
}
strings.addAll(Arrays.asList(pStrings));
}
return this;
}
/**
* Method sets attribute {@link #stringArray}.
*
* @param pStringArray Collection to which {@link #stringArray} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setStringArray( Set pStringArray ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pStringArray != null) {
stringArray = new HashSet(pStringArray);
}
else {
stringArray = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #stringArray}.
*
* @param pStringArray Array of objects that should be added to {@link #stringArray}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToStringArray( String... pStringArray ) {
if (pStringArray != null) {
if (stringArray == null) {
stringArray = new HashSet();
}
stringArray.addAll(Arrays.asList(pStringArray));
}
return this;
}
/**
* Method creates a new instance of class PrimitiveReferenceServiceObject. The object will be initialized with the
* values of the builder.
*
* @return PrimitiveReferenceServiceObject Created object. The method never returns null.
*/
public PrimitiveReferenceServiceObject build( ) {
PrimitiveReferenceServiceObject lObject = new PrimitiveReferenceServiceObject(this);
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
/**
* Method creates a new validated instance of class PrimitiveReferenceServiceObject. The object will be initialized
* with the values of the builder and validated afterwards.
*
* @return PrimitiveReferenceServiceObject Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public PrimitiveReferenceServiceObject buildValidated( ) throws ConstraintViolationException {
PrimitiveReferenceServiceObject lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns association {@link #aBoolean}.
*
* @return {@link Boolean} Value to which {@link #aBoolean} is set.
*/
public Boolean getABoolean( ) {
return aBoolean;
}
/**
* Method sets association {@link #aBoolean}.
*
* @param pABoolean Value to which {@link #aBoolean} should be set.
*/
public void setABoolean( Boolean pABoolean ) {
aBoolean = pABoolean;
}
/**
* Method unsets {@link #aBoolean}.
*/
public final void unsetABoolean( ) {
aBoolean = null;
}
/**
* Method returns association {@link #booleanSet}.
*
* @return {@link Set} Value to which {@link #booleanSet} is set. The method never returns null and the
* returned collection is unmodifiable.
*/
public Set getBooleanSet( ) {
// Return all Boolean objects as unmodifiable collection.
return Collections.unmodifiableSet(booleanSet);
}
/**
* Method adds the passed object to {@link #booleanSet}.
*
* @param pBooleanSet Object that should be added to {@link #booleanSet}. The parameter must not be null.
*/
public void addToBooleanSet( Boolean pBooleanSet ) {
// Check parameter "pBooleanSet" for invalid value null.
Check.checkInvalidParameterNull(pBooleanSet, "pBooleanSet");
// Add passed object to collection of associated Boolean objects.
booleanSet.add(pBooleanSet);
}
/**
* Method adds all passed objects to {@link #booleanSet}.
*
* @param pBooleanSet Collection with all objects that should be added to {@link #booleanSet}. The parameter must not
* be null.
*/
public void addToBooleanSet( Collection pBooleanSet ) {
// Check parameter "pBooleanSet" for invalid value null.
Check.checkInvalidParameterNull(pBooleanSet, "pBooleanSet");
// Add all passed objects.
for (Boolean lNextObject : pBooleanSet) {
this.addToBooleanSet(lNextObject);
}
}
/**
* Method removes the passed object from {@link #booleanSet}.
*
* @param pBooleanSet Object that should be removed from {@link #booleanSet}. The parameter must not be null.
*/
public void removeFromBooleanSet( Boolean pBooleanSet ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pBooleanSet, "pBooleanSet");
// Remove passed object from collection of associated Boolean objects.
booleanSet.remove(pBooleanSet);
}
/**
* Method removes all objects from {@link #booleanSet}.
*/
public void clearBooleanSet( ) {
// Remove all objects from association "booleanSet".
booleanSet.clear();
}
/**
* Method returns association {@link #buffers}.
*
* @return {@link Set} Value to which {@link #buffers} is set. The method never returns null and the
* returned collection is unmodifiable.
*/
public Set getBuffers( ) {
// Return all StringBuffer objects as unmodifiable collection.
return Collections.unmodifiableSet(buffers);
}
/**
* Method adds the passed object to {@link #buffers}.
*
* @param pBuffers Object that should be added to {@link #buffers}. The parameter must not be null.
*/
public void addToBuffers( StringBuffer pBuffers ) {
// Check parameter "pBuffers" for invalid value null.
Check.checkInvalidParameterNull(pBuffers, "pBuffers");
// Add passed object to collection of associated StringBuffer objects.
buffers.add(pBuffers);
}
/**
* Method adds all passed objects to {@link #buffers}.
*
* @param pBuffers Collection with all objects that should be added to {@link #buffers}. The parameter must not be
* null.
*/
public void addToBuffers( Collection pBuffers ) {
// Check parameter "pBuffers" for invalid value null.
Check.checkInvalidParameterNull(pBuffers, "pBuffers");
// Add all passed objects.
for (StringBuffer lNextObject : pBuffers) {
this.addToBuffers(lNextObject);
}
}
/**
* Method removes the passed object from {@link #buffers}.
*
* @param pBuffers Object that should be removed from {@link #buffers}. The parameter must not be null.
*/
public void removeFromBuffers( StringBuffer pBuffers ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pBuffers, "pBuffers");
// Remove passed object from collection of associated StringBuffer objects.
buffers.remove(pBuffers);
}
/**
* Method removes all objects from {@link #buffers}.
*/
public void clearBuffers( ) {
// Remove all objects from association "buffers".
buffers.clear();
}
/**
* Method returns association {@link #strings}.
*
* @return {@link Set} Value to which {@link #strings} is set. The method never returns null and the returned
* collection is unmodifiable.
*/
public Set getStrings( ) {
// Return all String objects as unmodifiable collection.
return Collections.unmodifiableSet(strings);
}
/**
* Method adds the passed object to {@link #strings}.
*
* @param pStrings Object that should be added to {@link #strings}. The parameter must not be null.
*/
public void addToStrings( String pStrings ) {
// Check parameter "pStrings" for invalid value null.
Check.checkInvalidParameterNull(pStrings, "pStrings");
// Add passed object to collection of associated String objects.
strings.add(pStrings);
}
/**
* Method adds all passed objects to {@link #strings}.
*
* @param pStrings Collection with all objects that should be added to {@link #strings}. The parameter must not be
* null.
*/
public void addToStrings( Collection pStrings ) {
// Check parameter "pStrings" for invalid value null.
Check.checkInvalidParameterNull(pStrings, "pStrings");
// Add all passed objects.
for (String lNextObject : pStrings) {
this.addToStrings(lNextObject);
}
}
/**
* Method removes the passed object from {@link #strings}.
*
* @param pStrings Object that should be removed from {@link #strings}. The parameter must not be null.
*/
public void removeFromStrings( String pStrings ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pStrings, "pStrings");
// Remove passed object from collection of associated String objects.
strings.remove(pStrings);
}
/**
* Method removes all objects from {@link #strings}.
*/
public void clearStrings( ) {
// Remove all objects from association "strings".
strings.clear();
}
/**
* Method returns attribute {@link #stringArray}.
*
* @return {@link Set} Value to which {@link #stringArray} is set.
*/
public Set getStringArray( ) {
// Return all String objects as unmodifiable collection.
return Collections.unmodifiableSet(stringArray);
}
/**
* Method adds the passed object to {@link #stringArray}.
*
* @param pStringArray Object that should be added to {@link #stringArray}. The parameter must not be null.
*/
public void addToStringArray( String pStringArray ) {
// Check parameter "pStringArray" for invalid value null.
Check.checkInvalidParameterNull(pStringArray, "pStringArray");
// Add passed object to collection of associated String objects.
stringArray.add(pStringArray);
}
/**
* Method adds all passed objects to {@link #stringArray}.
*
* @param pStringArray Collection with all objects that should be added to {@link #stringArray}. The parameter must
* not be null.
*/
public void addToStringArray( Collection pStringArray ) {
// Check parameter "pStringArray" for invalid value null.
Check.checkInvalidParameterNull(pStringArray, "pStringArray");
// Add all passed objects.
for (String lNextObject : pStringArray) {
this.addToStringArray(lNextObject);
}
}
/**
* Method removes the passed object from {@link #stringArray}.
*
* @param pStringArray Object that should be removed from {@link #stringArray}. The parameter must not be null.
*/
public void removeFromStringArray( String pStringArray ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pStringArray, "pStringArray");
// Remove passed object from collection of associated String objects.
stringArray.remove(pStringArray);
}
/**
* Method removes all objects from {@link #stringArray}.
*/
public void clearStringArray( ) {
// Remove all objects from association "stringArray".
stringArray.clear();
}
/**
* 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 PrimitiveReferenceServiceObject objects. The
* method never returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}