com.anaptecs.jeaf.junit.openapi.base.ParentClass 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.base;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
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;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.Nulls;
@Valid
@JsonIgnoreProperties(value = "objectType")
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "objectType", visible = true)
@JsonSubTypes({ @JsonSubTypes.Type(value = ChildAA.class, name = "ChildAA"),
@JsonSubTypes.Type(value = ChildB.class, name = "ChildB"),
@JsonSubTypes.Type(value = ChildBB.class, name = "ChildBB") })
public class ParentClass implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
@NotNull
private String parentAttribute;
@JsonSetter(nulls = Nulls.SKIP)
private Set ibans;
/**
* I would like to document references to other types.
*/
@Deprecated
private BankAccount theBankAccount;
/**
* Association is still there be SemVer compliant.
*/
@Deprecated
@JsonSetter(nulls = Nulls.SKIP)
private List legacyBankAccounts;
/**
* 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 ParentClass( ) {
ibans = new HashSet();
legacyBankAccounts = 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 ParentClass( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
parentAttribute = pBuilder.parentAttribute;
if (pBuilder.ibans != null) {
ibans = pBuilder.ibans;
}
else {
ibans = new HashSet();
}
theBankAccount = pBuilder.theBankAccount;
if (pBuilder.legacyBankAccounts != null) {
legacyBankAccounts = pBuilder.legacyBankAccounts;
}
else {
legacyBankAccounts = new ArrayList();
}
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new ParentClass objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class ParentClass.
*
*
* @param pParentAttribute Value to which {@link #parentAttribute} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.openapi.base.ParentClass}
*/
public static ParentClass of( String pParentAttribute ) {
ParentClass.Builder lBuilder = ParentClass.builder();
lBuilder.setParentAttribute(pParentAttribute);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class ParentClass.
*/
public static class Builder {
private String parentAttribute;
private Set ibans;
/**
* I would like to document references to other types.
*/
@Deprecated
private BankAccount theBankAccount;
/**
* Association is still there be SemVer compliant.
*/
@Deprecated
private List legacyBankAccounts;
/**
* Use {@link ParentClass#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link ParentClass#builder(ParentClass)} instead of private constructor to create new builder.
*/
protected Builder( ParentClass pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setParentAttribute(pObject.parentAttribute);
this.setIbans(pObject.ibans);
this.setTheBankAccount(pObject.theBankAccount);
this.setLegacyBankAccounts(pObject.legacyBankAccounts);
}
}
/**
* Method sets attribute {@link #parentAttribute}.
*
* @param pParentAttribute Value to which {@link #parentAttribute} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setParentAttribute( @MyNotNullProperty String pParentAttribute ) {
// Assign value to attribute
parentAttribute = pParentAttribute;
return this;
}
/**
* Method sets association {@link #ibans}.
*
* @param pIbans Collection to which {@link #ibans} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setIbans( Set pIbans ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pIbans != null) {
ibans = new HashSet(pIbans);
}
else {
ibans = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #ibans}.
*
* @param pIbans Array of objects that should be added to {@link #ibans}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToIbans( IBAN... pIbans ) {
if (pIbans != null) {
if (ibans == null) {
ibans = new HashSet();
}
ibans.addAll(Arrays.asList(pIbans));
}
return this;
}
/**
* Method sets association {@link #theBankAccount}.
*
* @param pTheBankAccount Value to which {@link #theBankAccount} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Deprecated
public Builder setTheBankAccount( BankAccount pTheBankAccount ) {
theBankAccount = pTheBankAccount;
return this;
}
/**
* Method sets association {@link #legacyBankAccounts}.
*
* @param pLegacyBankAccounts Collection to which {@link #legacyBankAccounts} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Deprecated
public Builder setLegacyBankAccounts( List pLegacyBankAccounts ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pLegacyBankAccounts != null) {
legacyBankAccounts = new ArrayList(pLegacyBankAccounts);
}
else {
legacyBankAccounts = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #legacyBankAccounts}.
*
* @param pLegacyBankAccounts Array of objects that should be added to {@link #legacyBankAccounts}. The parameter
* may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
@Deprecated
public Builder addToLegacyBankAccounts( BankAccount... pLegacyBankAccounts ) {
if (pLegacyBankAccounts != null) {
if (legacyBankAccounts == null) {
legacyBankAccounts = new ArrayList();
}
legacyBankAccounts.addAll(Arrays.asList(pLegacyBankAccounts));
}
return this;
}
/**
* Method creates a new instance of class ParentClass. The object will be initialized with the values of the
* builder.
*
* @return ParentClass Created object. The method never returns null.
*/
public ParentClass build( ) {
return new ParentClass(this);
}
/**
* Method creates a new validated instance of class ParentClass. The object will be initialized with the values of
* the builder and validated afterwards.
*
* @return ParentClass Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public ParentClass buildValidated( ) throws ConstraintViolationException {
ParentClass lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #parentAttribute}.
*
* @return {@link String} Value to which {@link #parentAttribute} is set.
*/
@MyNotNullProperty
public String getParentAttribute( ) {
return parentAttribute;
}
/**
* Method sets attribute {@link #parentAttribute}.
*
* @param pParentAttribute Value to which {@link #parentAttribute} should be set.
*/
public void setParentAttribute( @MyNotNullProperty String pParentAttribute ) {
// Assign value to attribute
parentAttribute = pParentAttribute;
}
/**
* Method returns association {@link #ibans}.
*
* @return {@link Set} Value to which {@link #ibans} is set. The method never returns null and the returned
* collection is modifiable.
*/
public Set getIbans( ) {
// Return all IBAN objects directly without any protection against modification.
return ibans;
}
/**
* Method adds the passed object to {@link #ibans}.
*
* @param pIbans Object that should be added to {@link #ibans}. The parameter must not be null.
*/
public void addToIbans( IBAN pIbans ) {
// Check parameter "pIbans" for invalid value null.
Check.checkInvalidParameterNull(pIbans, "pIbans");
// Add passed object to collection of associated IBAN objects.
ibans.add(pIbans);
}
/**
* Method adds all passed objects to {@link #ibans}.
*
* @param pIbans Collection with all objects that should be added to {@link #ibans}. The parameter must not be null.
*/
public void addToIbans( Collection pIbans ) {
// Check parameter "pIbans" for invalid value null.
Check.checkInvalidParameterNull(pIbans, "pIbans");
// Add all passed objects.
for (IBAN lNextObject : pIbans) {
this.addToIbans(lNextObject);
}
}
/**
* Method removes the passed object from {@link #ibans}.
*
* @param pIbans Object that should be removed from {@link #ibans}. The parameter must not be null.
*/
public void removeFromIbans( IBAN pIbans ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pIbans, "pIbans");
// Remove passed object from collection of associated IBAN objects.
ibans.remove(pIbans);
}
/**
* Method removes all objects from {@link #ibans}.
*/
public void clearIbans( ) {
// Remove all objects from association "ibans".
ibans.clear();
}
/**
* Method returns association {@link #theBankAccount}.
* I would like to document references to other types.
*
* @return {@link BankAccount} Value to which {@link #theBankAccount} is set.
*/
@Deprecated
public BankAccount getTheBankAccount( ) {
return theBankAccount;
}
/**
* Method sets association {@link #theBankAccount}.
* I would like to document references to other types.
*
* @param pTheBankAccount Value to which {@link #theBankAccount} should be set.
*/
@Deprecated
public void setTheBankAccount( BankAccount pTheBankAccount ) {
theBankAccount = pTheBankAccount;
}
/**
* Method unsets {@link #theBankAccount}.
*/
@Deprecated
public final void unsetTheBankAccount( ) {
theBankAccount = null;
}
/**
* Method returns association {@link #legacyBankAccounts}.
* Association is still there be SemVer compliant.
*
* @return {@link List} Value to which {@link #legacyBankAccounts} is set. The method never returns null
* and the returned collection is modifiable.
*/
@Deprecated
public List getLegacyBankAccounts( ) {
// Return all BankAccount objects directly without any protection against modification.
return legacyBankAccounts;
}
/**
* Method adds the passed object to {@link #legacyBankAccounts}.
*
* @param pLegacyBankAccounts Object that should be added to {@link #legacyBankAccounts}. The parameter must not be
* null.
*/
@Deprecated
public void addToLegacyBankAccounts( BankAccount pLegacyBankAccounts ) {
// Check parameter "pLegacyBankAccounts" for invalid value null.
Check.checkInvalidParameterNull(pLegacyBankAccounts, "pLegacyBankAccounts");
// Add passed object to collection of associated BankAccount objects.
legacyBankAccounts.add(pLegacyBankAccounts);
}
/**
* Method adds all passed objects to {@link #legacyBankAccounts}.
*
* @param pLegacyBankAccounts Collection with all objects that should be added to {@link #legacyBankAccounts}. The
* parameter must not be null.
*/
@Deprecated
public void addToLegacyBankAccounts( Collection pLegacyBankAccounts ) {
// Check parameter "pLegacyBankAccounts" for invalid value null.
Check.checkInvalidParameterNull(pLegacyBankAccounts, "pLegacyBankAccounts");
// Add all passed objects.
for (BankAccount lNextObject : pLegacyBankAccounts) {
this.addToLegacyBankAccounts(lNextObject);
}
}
/**
* Method removes the passed object from {@link #legacyBankAccounts}.
*
* @param pLegacyBankAccounts Object that should be removed from {@link #legacyBankAccounts}. The parameter must not
* be null.
*/
@Deprecated
public void removeFromLegacyBankAccounts( BankAccount pLegacyBankAccounts ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pLegacyBankAccounts, "pLegacyBankAccounts");
// Remove passed object from collection of associated BankAccount objects.
legacyBankAccounts.remove(pLegacyBankAccounts);
}
/**
* Method removes all objects from {@link #legacyBankAccounts}.
*/
@Deprecated
public void clearLegacyBankAccounts( ) {
// Remove all objects from association "legacyBankAccounts".
legacyBankAccounts.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());
lBuilder.append(pIndent);
lBuilder.append("parentAttribute: ");
lBuilder.append(parentAttribute);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("ibans: ");
if (ibans != null) {
lBuilder.append(ibans.size());
lBuilder.append(" element(s)");
}
else {
lBuilder.append(" null");
}
lBuilder.append(System.lineSeparator());
if (ibans != null) {
for (IBAN lNext : ibans) {
lBuilder.append(lNext.toStringBuilder(pIndent + " "));
lBuilder.append(System.lineSeparator());
}
}
lBuilder.append(pIndent);
lBuilder.append("theBankAccount: ");
if (theBankAccount != null) {
lBuilder.append(System.lineSeparator());
lBuilder.append(theBankAccount.toStringBuilder(pIndent + " "));
}
else {
lBuilder.append(" null");
lBuilder.append(System.lineSeparator());
}
lBuilder.append(pIndent);
lBuilder.append("legacyBankAccounts: ");
if (legacyBankAccounts != null) {
lBuilder.append(legacyBankAccounts.size());
lBuilder.append(" element(s)");
}
else {
lBuilder.append(" null");
}
lBuilder.append(System.lineSeparator());
if (legacyBankAccounts != null) {
for (BankAccount lNext : legacyBankAccounts) {
lBuilder.append(lNext.toStringBuilder(pIndent + " "));
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 ParentClass objects. The method never returns
* null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}