com.anaptecs.jeaf.junit.objectmapping.OtherMappingObject 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 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 OtherMappingObject implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
/**
* Constant for the name of attribute "value".
*/
public static final String VALUE = "value";
/**
* Constant for the name of attribute "name".
*/
public static final String NAME = "name";
private int value;
private String name;
/**
* 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 OtherMappingObject( ) {
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected OtherMappingObject( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
value = pBuilder.value;
name = pBuilder.name;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new OtherMappingObject objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class OtherMappingObject.
*
*
* @param pValue Value to which {@link #value} should be set.
*
* @param pName Value to which {@link #name} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.objectmapping.OtherMappingObject}
*/
public static OtherMappingObject of( int pValue, String pName ) {
OtherMappingObject.Builder lBuilder = OtherMappingObject.builder();
lBuilder.setValue(pValue);
lBuilder.setName(pName);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class OtherMappingObject.
*/
public static class Builder {
private int value;
private String name;
/**
* Use {@link OtherMappingObject#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link OtherMappingObject#builder(OtherMappingObject)} instead of private constructor to create new builder.
*/
protected Builder( OtherMappingObject pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setValue(pObject.value);
this.setName(pObject.name);
}
}
/**
* Method sets attribute {@link #value}.
*
* @param pValue Value to which {@link #value} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setValue( int pValue ) {
// Assign value to attribute
value = pValue;
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( String pName ) {
// Assign value to attribute
name = pName;
return this;
}
/**
* Method creates a new instance of class OtherMappingObject. The object will be initialized with the values of the
* builder.
*
* @return OtherMappingObject Created object. The method never returns null.
*/
public OtherMappingObject build( ) {
OtherMappingObject lObject = new OtherMappingObject(this);
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
/**
* Method creates a new validated instance of class OtherMappingObject. The object will be initialized with the
* values of the builder and validated afterwards.
*
* @return OtherMappingObject Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public OtherMappingObject buildValidated( ) throws ConstraintViolationException {
OtherMappingObject lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #value}.
*
* @return int Value to which {@link #value} is set.
*/
public int getValue( ) {
return value;
}
/**
* Method sets attribute {@link #value}.
*
* @param pValue Value to which {@link #value} should be set.
*/
public void setValue( int pValue ) {
// Assign value to attribute
value = pValue;
}
/**
* Method returns attribute {@link #name}.
*
* @return {@link String} Value to which {@link #name} is set.
*/
public String getName( ) {
return name;
}
/**
* Method sets attribute {@link #name}.
*
* @param pName Value to which {@link #name} should be set.
*/
public void setName( String pName ) {
// Assign value to attribute
name = pName;
}
/**
* 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("value: ");
lBuilder.append(value);
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 OtherMappingObject objects. The method never
* returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}