com.anaptecs.jeaf.junit.openapi.transientback.ClientClass Maven / Gradle / Ivy
The newest version!
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2021. All rights reserved.
*/
package com.anaptecs.jeaf.junit.openapi.transientback;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import javax.validation.ConstraintViolationException;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import com.anaptecs.annotations.MyNotNullProperty;
import com.anaptecs.jeaf.core.api.ServiceObject;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
@Valid
public class ClientClass implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
private transient MasterClass transientMaster;
@NotNull
private String name;
private transient List manyMasters;
/**
* 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 ClientClass( ) {
manyMasters = new ArrayList();
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected ClientClass( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
name = pBuilder.name;
manyMasters = new ArrayList();
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new ClientClass objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class ClientClass.
*
*
* @param pName Value to which {@link #name} should be set.
*
* @return {@link ClientClass}
*/
public static ClientClass of( String pName ) {
ClientClass.Builder lBuilder = ClientClass.builder();
lBuilder.setName(pName);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class ClientClass.
*/
public static class Builder {
private String name;
/**
* Use {@link ClientClass#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link ClientClass#builder(ClientClass)} instead of private constructor to create new builder.
*/
protected Builder( ClientClass pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setName(pObject.name);
}
}
/**
* Method sets attribute {@link #name}.
*
* @param pName Value to which {@link #name} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setName( @MyNotNullProperty String pName ) {
// Assign value to attribute
name = pName;
return this;
}
/**
* Method creates a new instance of class ClientClass. The object will be initialized with the values of the
* builder.
*
* @return ClientClass Created object. The method never returns null.
*/
public ClientClass build( ) {
return new ClientClass(this);
}
/**
* Method creates a new validated instance of class ClientClass. The object will be initialized with the values of
* the builder and validated afterwards.
*
* @return ClientClass Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public ClientClass buildValidated( ) throws ConstraintViolationException {
ClientClass lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns association {@link #transientMaster}.
*
* @return {@link MasterClass} Value to which {@link #transientMaster} is set.
*/
public MasterClass getTransientMaster( ) {
return transientMaster;
}
/**
* Method sets association {@link #transientMaster}.
*
* @param pTransientMaster Value to which {@link #transientMaster} should be set.
*/
void setTransientMaster( MasterClass pTransientMaster ) {
// Release already referenced object before setting a new association.
if (transientMaster != null) {
transientMaster.removeFromClients((ClientClass) this);
}
transientMaster = pTransientMaster;
}
/**
* Method unsets {@link #transientMaster}.
*/
final void unsetTransientMaster( ) {
transientMaster = null;
}
/**
* Method returns attribute {@link #name}.
*
* @return {@link String} Value to which {@link #name} is set.
*/
@MyNotNullProperty
public String getName( ) {
return name;
}
/**
* Method sets attribute {@link #name}.
*
* @param pName Value to which {@link #name} should be set.
*/
public void setName( @MyNotNullProperty String pName ) {
// Assign value to attribute
name = pName;
}
/**
* Method returns association {@link #manyMasters}.
*
* @return {@link List} Value to which {@link #manyMasters} is set. The method never returns null and the
* returned collection is modifiable.
*/
public List getManyMasters( ) {
// Return all MasterClass objects directly without any protection against modification.
return manyMasters;
}
/**
* Method adds the passed object to {@link #manyMasters}.
*
* @param pManyMasters Object that should be added to {@link #manyMasters}. The parameter must not be null.
*/
void addToManyMasters( MasterClass pManyMasters ) {
// Check parameter "pManyMasters" for invalid value null.
Check.checkInvalidParameterNull(pManyMasters, "pManyMasters");
// Add passed object to collection of associated MasterClass objects.
manyMasters.add(pManyMasters);
}
/**
* Method adds all passed objects to {@link #manyMasters}.
*
* @param pManyMasters Collection with all objects that should be added to {@link #manyMasters}. The parameter must
* not be null.
*/
void addToManyMasters( Collection pManyMasters ) {
// Check parameter "pManyMasters" for invalid value null.
Check.checkInvalidParameterNull(pManyMasters, "pManyMasters");
// Add all passed objects.
for (MasterClass lNextObject : pManyMasters) {
this.addToManyMasters(lNextObject);
}
}
/**
* Method removes the passed object from {@link #manyMasters}.
*
* @param pManyMasters Object that should be removed from {@link #manyMasters}. The parameter must not be null.
*/
void removeFromManyMasters( MasterClass pManyMasters ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pManyMasters, "pManyMasters");
// Remove passed object from collection of associated MasterClass objects.
manyMasters.remove(pManyMasters);
}
/**
* Method removes all objects from {@link #manyMasters}.
*/
void clearManyMasters( ) {
// Remove all objects from association "manyMasters".
Collection lManyMasters = new HashSet(manyMasters);
Iterator lIterator = lManyMasters.iterator();
while (lIterator.hasNext()) {
// As association is bidirectional we have to clear it in both directions.
this.removeFromManyMasters(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());
lBuilder.append(pIndent);
lBuilder.append("name: ");
lBuilder.append(name);
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 ClientClass objects. The method never returns
* null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}