com.anaptecs.spring.base.TechnicalHeaderContext Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.spring.base;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.anaptecs.annotations.MyNotNullProperty;
import com.anaptecs.jeaf.validation.api.spring.SpringValidationExecutor;
public class TechnicalHeaderContext {
/**
* Constant for the name of attribute "reseller".
*/
public static final String RESELLER = "reseller";
private String reseller;
/**
* Map contains all custom headers that were set on the object.
*/
private Map customHeaders = new HashMap();
/**
* 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.
*/
public TechnicalHeaderContext( ) {
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected TechnicalHeaderContext( Builder pBuilder ) {
// Read attribute values from builder.
reseller = pBuilder.reseller;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new TechnicalHeaderContext objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class TechnicalHeaderContext.
*
*
* @param pReseller Value to which {@link #reseller} should be set.
*
* @return {@link com.anaptecs.spring.base.TechnicalHeaderContext}
*/
public static TechnicalHeaderContext of( String pReseller ) {
TechnicalHeaderContext.Builder lBuilder = TechnicalHeaderContext.builder();
lBuilder.setReseller(pReseller);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class TechnicalHeaderContext.
*/
public static class Builder {
private String reseller;
/**
* Use {@link TechnicalHeaderContext#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link TechnicalHeaderContext#builder(TechnicalHeaderContext)} instead of private constructor to create new
* builder.
*/
protected Builder( TechnicalHeaderContext pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setReseller(pObject.reseller);
}
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new TechnicalHeaderContext objects.
*/
public static Builder newBuilder( ) {
return new Builder();
}
/**
* Method creates a new builder and initialize it with the data from the passed object.
*
* @param pObject Object that should be used to initialize the builder. The parameter may be null.
* @return {@link Builder} New builder that can be used to create new TechnicalHeaderContext objects. The method
* never returns null.
*/
public static Builder newBuilder( TechnicalHeaderContext pObject ) {
return new Builder(pObject);
}
/**
* Method sets attribute {@link #reseller}.
*
* @param pReseller Value to which {@link #reseller} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setReseller( @MyNotNullProperty String pReseller ) {
// Assign value to attribute
reseller = pReseller;
return this;
}
/**
* Method creates a new instance of class TechnicalHeaderContext. The object will be initialized with the values of
* the builder.
*
* @return TechnicalHeaderContext Created object. The method never returns null.
*/
public TechnicalHeaderContext build( ) {
TechnicalHeaderContext lObject = new TechnicalHeaderContext(this);
SpringValidationExecutor.getValidationExecutor().validateObject(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #reseller}.
*
* @return {@link String} Value to which {@link #reseller} is set.
*/
@MyNotNullProperty
public String getReseller( ) {
return reseller;
}
/**
* Method sets attribute {@link #reseller}.
*
* @param pReseller Value to which {@link #reseller} should be set.
*/
public void setReseller( @MyNotNullProperty String pReseller ) {
// Assign value to attribute
reseller = pReseller;
}
/**
* Method returns map with all custom headers that were added
*
* @return {@link Map} Map with all custom headers. The method never returns null. The returned map is unmodifiable.
*/
public Map getCustomHeaders( ) {
return Collections.unmodifiableMap(customHeaders);
}
/**
* Method adds the passed values as custom headers. The passed name and value of the http header must be compliant
* with guidelines about http headers.
*
* @param pHeaderName Name of the HTTP header. The parameter must not be null,
* @param pHeaderValue Value of the http header the parameter may be null.
*/
public void addCustomHeader( String pHeaderName, String pHeaderValue ) {
if (pHeaderName != null) {
customHeaders.put(pHeaderName, pHeaderValue);
}
else {
throw new IllegalArgumentException("Parameter 'pHeaderName' must not be null.");
}
}
@Override
public int hashCode( ) {
final int lPrime = 31;
int lResult = 1;
lResult = lPrime * lResult + Objects.hashCode(reseller);
lResult = lPrime * lResult + Objects.hashCode(customHeaders);
return lResult;
}
@Override
public boolean equals( Object pObject ) {
boolean lEquals;
if (this == pObject) {
lEquals = true;
}
else if (pObject == null) {
lEquals = false;
}
else if (this.getClass() != pObject.getClass()) {
lEquals = false;
}
else {
TechnicalHeaderContext lOther = (TechnicalHeaderContext) pObject;
lEquals = Objects.equals(reseller, lOther.reseller) && Objects.equals(customHeaders, lOther.customHeaders);
}
return lEquals;
}
/**
* 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("reseller: ");
lBuilder.append(reseller);
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 TechnicalHeaderContext objects. The method never
* returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}