com.anaptecs.jeaf.junit.openapi.base.Company Maven / Gradle / Ivy
/*
* 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.List;
import javax.validation.ConstraintViolationException;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import com.anaptecs.annotations.MyNotNullProperty;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.common.ObjectIdentity;
@Valid
public class Company extends Partner {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
@NotNull
private String name;
private StringCode code;
/**
* 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 Company( ) {
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected Company( Builder pBuilder ) {
// Call constructor of super class.
super(pBuilder);
// Read attribute values from builder.
name = pBuilder.name;
code = pBuilder.code;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new Company objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class Company.
*
*
* @param pName Value to which {@link #name} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.openapi.base.Company}
*/
public static Company of( String pName ) {
Company.Builder lBuilder = Company.builder();
lBuilder.setName(pName);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class Company.
*/
public static class Builder extends Partner.Builder {
private String name;
private StringCode code;
/**
* Use {@link Company#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
super();
}
/**
* Use {@link Company#builder(Company)} instead of private constructor to create new builder.
*/
protected Builder( Company pObject ) {
super(pObject);
if (pObject != null) {
// Read attribute values from passed object.
this.setName(pObject.name);
this.setCode(pObject.code);
}
}
/**
* Method sets the identifier for the object created using the builder. The reference may be null since an id is not
* mandatory.
*/
@Override
public Builder setID( ObjectIdentity pObjectID ) {
super.setID(pObjectID);
return this;
}
/**
* Method sets association {@link #postalAddresses}.
*
* @param pPostalAddresses Collection to which {@link #postalAddresses} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setPostalAddresses( List pPostalAddresses ) {
// Call super class implementation.
super.setPostalAddresses(pPostalAddresses);
return this;
}
/**
* Method adds the passed objects to association {@link #postalAddresses}.
*
* @param pPostalAddresses Array of objects that should be added to {@link #postalAddresses}. The parameter may be
* null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToPostalAddresses( PostalAddress... pPostalAddresses ) {
// Call super class implementation.
super.addToPostalAddresses(pPostalAddresses);
return this;
}
/**
* 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 sets association {@link #code}.
*
* @param pCode Value to which {@link #code} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setCode( StringCode pCode ) {
code = pCode;
return this;
}
/**
* Method creates a new instance of class Company. The object will be initialized with the values of the builder.
*
* @return Company Created object. The method never returns null.
*/
public Company build( ) {
return new Company(this);
}
/**
* Method creates a new validated instance of class Company. The object will be initialized with the values of the
* builder and validated afterwards.
*
* @return Company Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public Company buildValidated( ) throws ConstraintViolationException {
Company lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* 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 #code}.
*
* @return {@link StringCode} Value to which {@link #code} is set.
*/
public StringCode getCode( ) {
return code;
}
/**
* Method sets association {@link #code}.
*
* @param pCode Value to which {@link #code} should be set.
*/
public void setCode( StringCode pCode ) {
code = pCode;
}
/**
* Method unsets {@link #code}.
*/
public final void unsetCode( ) {
code = null;
}
/**
* 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.
*/
@Override
public StringBuilder toStringBuilder( String pIndent ) {
StringBuilder lBuilder = super.toStringBuilder(pIndent);
lBuilder.append(pIndent);
lBuilder.append("name: ");
lBuilder.append(name);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("code: ");
if (code != null) {
lBuilder.append(System.lineSeparator());
lBuilder.append(code.toStringBuilder(pIndent + " "));
}
else {
lBuilder.append(" null");
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 Company objects. The method never returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}