com.anaptecs.jeaf.accounting.Booking Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.jeaf.accounting;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import javax.validation.ConstraintViolationException;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import com.anaptecs.jeaf.core.api.ServiceObject;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
@Valid
public class Booking implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
/**
* Constant for the name of attribute "amount".
*/
public static final String AMOUNT = "amount";
/**
* Constant for the name of attribute "source".
*/
public static final String SOURCE = "source";
/**
* Constant for the name of attribute "target".
*/
public static final String TARGET = "target";
/**
* Constant for the name of attribute "token".
*/
public static final String TOKEN = "token";
/**
* Constant for the name of attribute "remitters".
*/
public static final String REMITTERS = "remitters";
/**
* Constant for the name of attribute "account".
*/
public static final String ACCOUNT = "account";
/**
* Amount of the booking. The attribute must not be null.
*/
@NotNull
private Double amount;
private Account source;
private Account target;
private SecurityToken token;
private Set remitters;
private transient Account account;
/**
* 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 Booking( ) {
remitters = new HashSet();
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected Booking( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
amount = pBuilder.amount;
source = pBuilder.source;
target = pBuilder.target;
token = pBuilder.token;
if (token != null) {
// As association is bidirectional we also have to set it in the other direction.
token.setBooking((Booking) this);
}
if (pBuilder.remitters != null) {
remitters = pBuilder.remitters;
}
else {
remitters = new HashSet();
}
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new Booking objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class Booking.
*
*
* @param pAmount Value to which {@link #amount} should be set.
*
* @param pSource Value to which {@link #source} should be set.
*
* @param pTarget Value to which {@link #target} should be set.
*
* @param pToken Value to which {@link #token} should be set.
*
* @param pRemitters Value to which {@link #remitters} should be set.
*
* @return {@link Booking}
*/
public static Booking of( Double pAmount, Account pSource, Account pTarget, SecurityToken pToken,
Set pRemitters ) {
Booking.Builder lBuilder = Booking.builder();
lBuilder.setAmount(pAmount);
lBuilder.setSource(pSource);
lBuilder.setTarget(pTarget);
lBuilder.setToken(pToken);
lBuilder.setRemitters(pRemitters);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class Booking.
*/
public static class Builder {
/**
* Amount of the booking. The attribute must not be null.
*/
@NotNull
private Double amount;
private Account source;
private Account target;
private SecurityToken token;
private Set remitters;
/**
* Use {@link Booking#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link Booking#builder(Booking)} instead of private constructor to create new builder.
*/
protected Builder( Booking pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setAmount(pObject.amount);
this.setSource(pObject.source);
this.setTarget(pObject.target);
this.setToken(pObject.token);
this.setRemitters(pObject.remitters);
}
}
/**
* Method sets attribute {@link #amount}.
*
* @param pAmount Value to which {@link #amount} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setAmount( Double pAmount ) {
// Assign value to attribute
amount = pAmount;
return this;
}
/**
* Method sets association {@link #source}.
*
* @param pSource Value to which {@link #source} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setSource( Account pSource ) {
source = pSource;
return this;
}
/**
* Method sets association {@link #target}.
*
* @param pTarget Value to which {@link #target} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setTarget( Account pTarget ) {
target = pTarget;
return this;
}
/**
* Method sets association {@link #token}.
*
* @param pToken Value to which {@link #token} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setToken( SecurityToken pToken ) {
token = pToken;
return this;
}
/**
* Method sets association {@link #remitters}.
*
* @param pRemitters Collection to which {@link #remitters} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setRemitters( Set pRemitters ) {
// To ensure immutability we have to copy the content of the passed collection.
if (pRemitters != null) {
remitters = new HashSet(pRemitters);
}
else {
remitters = null;
}
return this;
}
/**
* Method adds the passed objects to association {@link #remitters}.
*
* @param pRemitters Array of objects that should be added to {@link #remitters}. The parameter may be null.
* @return {@link Builder} Instance of this builder to support chaining. Method never returns null.
*/
public Builder addToRemitters( Person... pRemitters ) {
if (pRemitters != null) {
if (remitters == null) {
remitters = new HashSet();
}
remitters.addAll(Arrays.asList(pRemitters));
}
return this;
}
/**
* Method creates a new instance of class Booking. The object will be initialized with the values of the builder.
*
* @return Booking Created object. The method never returns null.
*/
public Booking build( ) {
Booking lObject = new Booking(this);
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
/**
* Method creates a new validated instance of class Booking. The object will be initialized with the values of the
* builder and validated afterwards.
*
* @return Booking Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public Booking buildValidated( ) throws ConstraintViolationException {
Booking lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #amount}.
* Amount of the booking. The attribute must not be null.
*
* @return {@link Double} Value to which {@link #amount} is set.
*/
public Double getAmount( ) {
return amount;
}
/**
* Method sets attribute {@link #amount}.
* Amount of the booking. The attribute must not be null.
*
* @param pAmount Value to which {@link #amount} should be set.
*/
public void setAmount( Double pAmount ) {
// Assign value to attribute
amount = pAmount;
}
/**
* Method returns association {@link #source}.
*
* @return {@link Account} Value to which {@link #source} is set.
*/
public Account getSource( ) {
return source;
}
/**
* Method sets association {@link #source}.
*
* @param pSource Value to which {@link #source} should be set.
*/
public void setSource( Account pSource ) {
source = pSource;
}
/**
* Method unsets {@link #source}.
*/
public final void unsetSource( ) {
source = null;
}
/**
* Method returns association {@link #target}.
*
* @return {@link Account} Value to which {@link #target} is set.
*/
public Account getTarget( ) {
return target;
}
/**
* Method sets association {@link #target}.
*
* @param pTarget Value to which {@link #target} should be set.
*/
public void setTarget( Account pTarget ) {
target = pTarget;
}
/**
* Method unsets {@link #target}.
*/
public final void unsetTarget( ) {
target = null;
}
/**
* Method returns association {@link #token}.
*
* @return {@link SecurityToken} Value to which {@link #token} is set.
*/
public SecurityToken getToken( ) {
return token;
}
/**
* Method sets association {@link #token}.
*
* @param pToken Value to which {@link #token} should be set.
*/
public void setToken( SecurityToken pToken ) {
// Release already referenced object before setting a new association.
if (token != null) {
token.unsetBooking();
}
token = pToken;
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
if (pToken != null && this.equals(pToken.getBooking()) == false) {
pToken.setBooking((Booking) this);
}
}
/**
* Method unsets {@link #token}.
*/
public final void unsetToken( ) {
// The association is set in both directions because within the UML model it is defined to be bidirectional.
// In case that one side will be removed from the association the other side will also be removed.
SecurityToken lSecurityToken = token;
token = null;
if (lSecurityToken != null && this.equals(lSecurityToken.getBooking()) == true) {
lSecurityToken.unsetBooking();
}
}
/**
* Method returns association {@link #remitters}.
*
* @return {@link Set} Value to which {@link #remitters} is set. The method never returns null and the
* returned collection is unmodifiable.
*/
public Set getRemitters( ) {
// Return all Person objects as unmodifiable collection.
return Collections.unmodifiableSet(remitters);
}
/**
* Method adds the passed object to {@link #remitters}.
*
* @param pRemitters Object that should be added to {@link #remitters}. The parameter must not be null.
*/
public void addToRemitters( Person pRemitters ) {
// Check parameter "pRemitters" for invalid value null.
Check.checkInvalidParameterNull(pRemitters, "pRemitters");
// Add passed object to collection of associated Person objects.
remitters.add(pRemitters);
}
/**
* Method adds all passed objects to {@link #remitters}.
*
* @param pRemitters Collection with all objects that should be added to {@link #remitters}. The parameter must not be
* null.
*/
public void addToRemitters( Collection pRemitters ) {
// Check parameter "pRemitters" for invalid value null.
Check.checkInvalidParameterNull(pRemitters, "pRemitters");
// Add all passed objects.
for (Person lNextObject : pRemitters) {
this.addToRemitters(lNextObject);
}
}
/**
* Method removes the passed object from {@link #remitters}.
*
* @param pRemitters Object that should be removed from {@link #remitters}. The parameter must not be null.
*/
public void removeFromRemitters( Person pRemitters ) {
// Check parameter for invalid value null.
Check.checkInvalidParameterNull(pRemitters, "pRemitters");
// Remove passed object from collection of associated Person objects.
remitters.remove(pRemitters);
}
/**
* Method removes all objects from {@link #remitters}.
*/
public void clearRemitters( ) {
// Remove all objects from association "remitters".
remitters.clear();
}
/**
* Method returns association {@link #account}.
*
* @return {@link Account} Value to which {@link #account} is set.
*/
public Account getAccount( ) {
return account;
}
/**
* Method sets association {@link #account}.
*
* @param pAccount Value to which {@link #account} should be set.
*/
void setAccount( Account pAccount ) {
// Release already referenced object before setting a new association.
if (account != null) {
account.removeFromBookings((Booking) this);
}
account = pAccount;
}
/**
* Method unsets {@link #account}.
*/
final void unsetAccount( ) {
account = 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.
*/
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("amount: ");
lBuilder.append(amount);
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 Booking objects. The method never returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy