com.anaptecs.jeaf.accounting.AccountInfoBase Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.jeaf.accounting;
import javax.validation.ConstraintViolationException;
import com.anaptecs.jeaf.core.api.ServiceObject;
import com.anaptecs.jeaf.core.api.ServiceObjectID;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
import com.anaptecs.jeaf.xfun.api.common.Identifiable;
import com.anaptecs.jeaf.xfun.api.common.ObjectIdentity;
public abstract class AccountInfoBase implements ServiceObject, Identifiable {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
/**
* Constant for the name of attribute "iban".
*/
public static final String IBAN = "iban";
/**
* Constant for the name of attribute "balance".
*/
public static final String BALANCE = "balance";
/**
* Constant for the name of attribute "bankID".
*/
public static final String BANKID = "bankID";
/**
* Reference to the identifier of this object. The reference may be null since an id is not mandatory.
*/
private final ServiceObjectID objectID;
private Long iban;
private Double balance;
private ServiceObjectID bankID;
/**
* 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 AccountInfoBase( ) {
objectID = 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 AccountInfoBase( BuilderBase pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read object ID.
ObjectIdentity lObjectID = pBuilder.objectID;
if (lObjectID != null) {
objectID = new ServiceObjectID(pBuilder.objectID);
}
else {
objectID = null;
}
// Read attribute values from builder.
iban = pBuilder.iban;
balance = pBuilder.balance;
bankID = pBuilder.bankID;
}
/**
* Class implements builder to create a new instance of class AccountInfo. As the class has read only attributes or
* associations instances can not be created directly. Instead this builder class has to be used.
*/
public static abstract class BuilderBase {
/**
* Reference to the identifier of this object. The reference may be null since an id is not mandatory.
*/
private ObjectIdentity objectID;
private Long iban;
private Double balance;
private ServiceObjectID bankID;
/**
* Use {@link AccountInfo.builder()} instead of protected constructor to create new builder.
*/
protected BuilderBase( ) {
}
/**
* Use {@link AccountInfo.builder(AccountInfo)} instead of protected constructor to create new builder.
*/
protected BuilderBase( AccountInfoBase pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
objectID = pObject.objectID;
this.setIban(pObject.iban);
this.setBalance(pObject.balance);
this.setBankID(pObject.bankID);
}
}
/**
* Method sets the identifier for the object created using the builder. The reference may be null since an id is not
* mandatory.
*/
public BuilderBase setID( ObjectIdentity pObjectID ) {
objectID = pObjectID;
return this;
}
/**
* Method sets attribute {@link #iban}.
*
* @param pIban Value to which {@link #iban} should be set.
* @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null.
*/
public BuilderBase setIban( Long pIban ) {
// Assign value to attribute
iban = pIban;
return this;
}
/**
* Method sets attribute {@link #balance}.
*
* @param pBalance Value to which {@link #balance} should be set.
* @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null.
*/
public BuilderBase setBalance( Double pBalance ) {
// Assign value to attribute
balance = pBalance;
return this;
}
/**
* Method sets attribute {@link #bankID}.
*
* @param pBankID Value to which {@link #bankID} should be set.
* @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null.
*/
public BuilderBase setBankID( ServiceObjectID pBankID ) {
// Assign value to attribute
bankID = pBankID;
return this;
}
/**
* Method creates a new instance of class AccountInfo. The object will be initialized with the values of the
* builder.
*
* @return AccountInfo Created object. The method never returns null.
*/
public AccountInfo build( ) {
AccountInfo lObject = new AccountInfo(this);
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
/**
* Method creates a new validated instance of class AccountInfo. The object will be initialized with the values of
* the builder and validated afterwards.
*
* @return AccountInfo Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public AccountInfo buildValidated( ) throws ConstraintViolationException {
AccountInfo lPOJO = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lPOJO);
return lPOJO;
}
}
/**
* Method returns the id of this object.
*
* @return {@link ServiceObjectID} ID of this object. Since an object must not have an id the method may also return
* null.
*/
@Override
public final ServiceObjectID getID( ) {
return objectID;
}
/**
* Method returns the unversioned object id of this object.
*
* @return {@link ServiceObjectID} ID of this object. Since an object must not have an id the method may also return
* null.
*/
@Override
public final ServiceObjectID getUnversionedID( ) {
ServiceObjectID lUnversionedID;
if (objectID != null) {
lUnversionedID = objectID.getUnversionedObjectID();
}
else {
lUnversionedID = null;
}
return lUnversionedID;
}
/**
* Method returns attribute {@link #iban}.
*
* @return {@link Long} Value to which {@link #iban} is set.
*/
public Long getIban( ) {
return iban;
}
/**
* Method sets attribute {@link #iban}.
*
* @param pIban Value to which {@link #iban} should be set.
*/
public void setIban( Long pIban ) {
// Assign value to attribute
iban = pIban;
}
/**
* Method returns attribute {@link #balance}.
*
* @return {@link Double} Value to which {@link #balance} is set.
*/
public Double getBalance( ) {
return balance;
}
/**
* Method sets attribute {@link #balance}.
*
* @param pBalance Value to which {@link #balance} should be set.
*/
public void setBalance( Double pBalance ) {
// Assign value to attribute
balance = pBalance;
}
/**
* Method returns attribute {@link #bankID}.
*
* @return {@link ServiceObjectID} Value to which {@link #bankID} is set.
*/
public ServiceObjectID getBankID( ) {
return bankID;
}
/**
* Method sets attribute {@link #bankID}.
*
* @param pBankID Value to which {@link #bankID} should be set.
*/
public void setBankID( ServiceObjectID pBankID ) {
// Assign value to attribute
bankID = pBankID;
}
/**
* Convenience method to create new instance of class AccountInfo.
*
*
* @param pIban Value to which {@link #iban} should be set.
*
* @param pBalance Value to which {@link #balance} should be set.
*
* @param pBankID Value to which {@link #bankID} should be set.
*
* @return {@link com.anaptecs.jeaf.accounting.AccountInfo}
*/
public static AccountInfo of( Long pIban, Double pBalance, ServiceObjectID pBankID ) {
AccountInfo.Builder lBuilder = AccountInfo.builder();
lBuilder.setIban(pIban);
lBuilder.setBalance(pBalance);
lBuilder.setBankID(pBankID);
return lBuilder.build();
}
/**
* @return {@link Double}
*/
public abstract Double calclulateBalance( );
/**
* 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("iban: ");
lBuilder.append(iban);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("balance: ");
lBuilder.append(balance);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("bankID: ");
lBuilder.append(bankID);
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 AccountInfo objects. The method never returns
* null.
*/
public AccountInfo.Builder toBuilder( ) {
return new AccountInfo.Builder((AccountInfo) this);
}
}