com.anaptecs.jeaf.junit.openapi.base.TheReadOnlyServiceObject 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.Arrays;
import java.util.HashSet;
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.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;
@Valid
public class TheReadOnlyServiceObject implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
@NotNull
private final String name;
/**
*
* Breaking Change with PI 16: At least one bit will be expected.
*/
private final boolean[] bits;
@JsonSetter(nulls = Nulls.SKIP)
private final Set bookingCodes;
/**
* @deprecated Let's reproduce #65 (since: not too long, removed with: 99.9)
*/
@Deprecated
private final InventoryType inventoryType;
/**
* 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 TheReadOnlyServiceObject( ) {
name = null;
bits = null;
bookingCodes = new HashSet();
inventoryType = null;
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected TheReadOnlyServiceObject( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
name = pBuilder.name;
bits = pBuilder.bits;
if (pBuilder.bookingCodes != null) {
bookingCodes = pBuilder.bookingCodes;
}
else {
bookingCodes = new HashSet();
}
inventoryType = pBuilder.inventoryType;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new TheReadOnlyServiceObject objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class TheReadOnlyServiceObject.
*
*
* @param pName Value to which {@link #name} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.openapi.base.TheReadOnlyServiceObject}
*/
public static TheReadOnlyServiceObject of( String pName ) {
TheReadOnlyServiceObject.Builder lBuilder = TheReadOnlyServiceObject.builder();
lBuilder.setName(pName);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class TheReadOnlyServiceObject.
*/
public static class Builder {
private String name;
/**
*
* Breaking Change with PI 16: At least one bit will be expected.
*/
private boolean[] bits;
private Set bookingCodes;
/**
* @deprecated Let's reproduce #65 (since: not too long, removed with: 99.9)
*/
@Deprecated
private InventoryType inventoryType;
/**
* Use {@link TheReadOnlyServiceObject#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link TheReadOnlyServiceObject#builder(TheReadOnlyServiceObject)} instead of private constructor to create
* new builder.
*/
protected Builder( TheReadOnlyServiceObject pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setName(pObject.name);
this.setBits(pObject.bits);
this.setBookingCodes(pObject.bookingCodes);
this.setInventoryType(pObject.inventoryType);
}
}
/**
* 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 attribute {@link #bits}.
*
* Breaking Change with PI 16: At least one bit will be expected.
*
* @param pBits Value to which {@link #bits} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setBits( boolean[] pBits ) {
// Assign value to attribute
if (pBits != null) {
bits = pBits;
}
else {
bits = null;
}
return this;
}
/**
* Method sets association {@link #bookingCodes}.
*
* @param pBookingCodes Collection to which {@link #bookingCodes} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setBookingCodes( Set pBookingCodes ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pBookingCodes != null) {
bookingCodes = new HashSet(pBookingCodes);
}
else {
bookingCodes = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #bookingCodes}.
*
* @param pBookingCodes Array of objects that should be added to {@link #bookingCodes}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToBookingCodes( BookingCode... pBookingCodes ) {
if (pBookingCodes != null) {
if (bookingCodes == null) {
bookingCodes = new HashSet();
}
bookingCodes.addAll(Arrays.asList(pBookingCodes));
}
return this;
}
/**
* Method sets association {@link #inventoryType}.
*
* @param pInventoryType Value to which {@link #inventoryType} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
* @deprecated Let's reproduce #65 (since: not too long, removed with: 99.9)
*/
@Deprecated
public Builder setInventoryType( InventoryType pInventoryType ) {
inventoryType = pInventoryType;
return this;
}
/**
* Method creates a new instance of class TheReadOnlyServiceObject. The object will be initialized with the values
* of the builder.
*
* @return TheReadOnlyServiceObject Created object. The method never returns null.
*/
public TheReadOnlyServiceObject build( ) {
return new TheReadOnlyServiceObject(this);
}
/**
* Method creates a new validated instance of class TheReadOnlyServiceObject. The object will be initialized with
* the values of the builder and validated afterwards.
*
* @return TheReadOnlyServiceObject Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public TheReadOnlyServiceObject buildValidated( ) throws ConstraintViolationException {
TheReadOnlyServiceObject 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 returns attribute {@link #bits}.
*
* Breaking Change with PI 16: At least one bit will be expected.
*
* @return boolean[] Value to which {@link #bits} is set.
*/
public boolean[] getBits( ) {
boolean[] lReturnValue;
if (bits != null) {
lReturnValue = bits;
}
else {
lReturnValue = null;
}
return lReturnValue;
}
/**
* Method returns association {@link #bookingCodes}.
*
* @return {@link Set} Value to which {@link #bookingCodes} is set. The method never returns null and the
* returned collection is modifiable.
*/
public Set getBookingCodes( ) {
// Return all BookingCode objects directly without any protection against modification.
return bookingCodes;
}
/**
* Method returns association {@link #inventoryType}.
*
* @return {@link InventoryType} Value to which {@link #inventoryType} is set.
* @deprecated Let's reproduce #65 (since: not too long, removed with: 99.9)
*/
@Deprecated
public InventoryType getInventoryType( ) {
return inventoryType;
}
/**
* 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());
lBuilder.append(pIndent);
lBuilder.append("bits: ");
if (bits != null) {
lBuilder.append(Arrays.toString(bits));
}
else {
lBuilder.append(" null");
}
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("bookingCodes: ");
if (bookingCodes != null) {
lBuilder.append(bookingCodes.size());
lBuilder.append(" element(s)");
}
else {
lBuilder.append(" null");
}
lBuilder.append(System.lineSeparator());
if (bookingCodes != null) {
for (BookingCode lNext : bookingCodes) {
lBuilder.append(lNext.toStringBuilder(pIndent + " "));
lBuilder.append(System.lineSeparator());
}
}
lBuilder.append(pIndent);
lBuilder.append("inventoryType: ");
lBuilder.append(inventoryType);
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 TheReadOnlyServiceObject objects. The method
* never returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}