com.anaptecs.jeaf.junit.openapi.base.SpecialContext 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.Locale;
import javax.validation.ConstraintViolationException;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.ws.rs.HeaderParam;
import com.anaptecs.annotations.MyNotNullProperty;
import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
@Valid
public class SpecialContext extends Context {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
@HeaderParam("specificHeader")
@NotNull
private String specificHeader;
@Deprecated
@HeaderParam("deprecatedHeader")
@NotNull
private IntegerCode deprecatedHeader;
@HeaderParam("deprecatedType")
@NotNull
private DeprecatedType deprecatedType;
/**
* 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 SpecialContext( ) {
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected SpecialContext( Builder pBuilder ) {
// Call constructor of super class.
super(pBuilder);
// Read attribute values from builder.
specificHeader = pBuilder.specificHeader;
deprecatedHeader = pBuilder.deprecatedHeader;
deprecatedType = pBuilder.deprecatedType;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new SpecialContext objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class SpecialContext.
*
*
* @param pAccessToken Value to which {@link #accessToken} should be set.
*
* @param pLanguage Value to which {@link #language} should be set.
*
* @param pResellerID Value to which {@link #resellerID} should be set.
*
* @param pPathParam Value to which {@link #pathParam} should be set.
*
* @param pQueryParam Value to which {@link #queryParam} should be set.
*
* @param pSpecificHeader Value to which {@link #specificHeader} should be set.
*
* @param pDeprecatedHeader Value to which {@link #deprecatedHeader} should be set.
*
* @param pDeprecatedType Value to which {@link #deprecatedType} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.openapi.base.SpecialContext}
*/
public static SpecialContext of( String pAccessToken, Locale pLanguage, long pResellerID, long pPathParam,
String pQueryParam, String pSpecificHeader, IntegerCode pDeprecatedHeader, DeprecatedType pDeprecatedType ) {
SpecialContext.Builder lBuilder = SpecialContext.builder();
lBuilder.setAccessToken(pAccessToken);
lBuilder.setLanguage(pLanguage);
lBuilder.setResellerID(pResellerID);
lBuilder.setPathParam(pPathParam);
lBuilder.setQueryParam(pQueryParam);
lBuilder.setSpecificHeader(pSpecificHeader);
lBuilder.setDeprecatedHeader(pDeprecatedHeader);
lBuilder.setDeprecatedType(pDeprecatedType);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class SpecialContext.
*/
public static class Builder extends Context.Builder {
private String specificHeader;
@Deprecated
private IntegerCode deprecatedHeader;
private DeprecatedType deprecatedType;
/**
* Use {@link SpecialContext#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
super();
}
/**
* Use {@link SpecialContext#builder(SpecialContext)} instead of private constructor to create new builder.
*/
protected Builder( SpecialContext pObject ) {
super(pObject);
if (pObject != null) {
// Read attribute values from passed object.
this.setSpecificHeader(pObject.specificHeader);
this.setDeprecatedHeader(pObject.deprecatedHeader);
this.setDeprecatedType(pObject.deprecatedType);
}
}
/**
* Method sets attribute {@link #accessToken}.
*
* @param pAccessToken Value to which {@link #accessToken} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setAccessToken( String pAccessToken ) {
// Call super class implementation.
super.setAccessToken(pAccessToken);
return this;
}
/**
* Method sets attribute {@link #language}.
*
* @param pLanguage Value to which {@link #language} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setLanguage( Locale pLanguage ) {
// Call super class implementation.
super.setLanguage(pLanguage);
return this;
}
/**
* Method sets attribute {@link #resellerID}.
*
* @param pResellerID Value to which {@link #resellerID} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setResellerID( long pResellerID ) {
// Call super class implementation.
super.setResellerID(pResellerID);
return this;
}
/**
* Method sets attribute {@link #pathParam}.
*
* @param pPathParam Value to which {@link #pathParam} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setPathParam( long pPathParam ) {
// Call super class implementation.
super.setPathParam(pPathParam);
return this;
}
/**
* Method sets attribute {@link #queryParam}.
*
* @param pQueryParam Value to which {@link #queryParam} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setQueryParam( String pQueryParam ) {
// Call super class implementation.
super.setQueryParam(pQueryParam);
return this;
}
/**
* Method sets attribute {@link #intCode}.
*
* @param pIntCode Value to which {@link #intCode} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Override
public Builder setIntCode( IntegerCodeType pIntCode ) {
// Call super class implementation.
super.setIntCode(pIntCode);
return this;
}
/**
* Method sets attribute {@link #specificHeader}.
*
* @param pSpecificHeader Value to which {@link #specificHeader} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setSpecificHeader( @MyNotNullProperty String pSpecificHeader ) {
// Assign value to attribute
specificHeader = pSpecificHeader;
return this;
}
/**
* Method sets attribute {@link #deprecatedHeader}.
*
* @param pDeprecatedHeader Value to which {@link #deprecatedHeader} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Deprecated
public Builder setDeprecatedHeader( @MyNotNullProperty IntegerCode pDeprecatedHeader ) {
// Assign value to attribute
deprecatedHeader = pDeprecatedHeader;
return this;
}
/**
* Method sets attribute {@link #deprecatedType}.
*
* @param pDeprecatedType Value to which {@link #deprecatedType} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setDeprecatedType( @MyNotNullProperty DeprecatedType pDeprecatedType ) {
// Assign value to attribute
deprecatedType = pDeprecatedType;
return this;
}
/**
* Method creates a new instance of class SpecialContext. The object will be initialized with the values of the
* builder.
*
* @return SpecialContext Created object. The method never returns null.
*/
public SpecialContext build( ) {
return new SpecialContext(this);
}
/**
* Method creates a new validated instance of class SpecialContext. The object will be initialized with the values
* of the builder and validated afterwards.
*
* @return SpecialContext Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public SpecialContext buildValidated( ) throws ConstraintViolationException {
SpecialContext lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #specificHeader}.
*
* @return {@link String} Value to which {@link #specificHeader} is set.
*/
@MyNotNullProperty
public String getSpecificHeader( ) {
return specificHeader;
}
/**
* Method sets attribute {@link #specificHeader}.
*
* @param pSpecificHeader Value to which {@link #specificHeader} should be set.
*/
public void setSpecificHeader( @MyNotNullProperty String pSpecificHeader ) {
// Assign value to attribute
specificHeader = pSpecificHeader;
}
/**
* Method returns attribute {@link #deprecatedHeader}.
*
* @return {@link IntegerCode} Value to which {@link #deprecatedHeader} is set.
*/
@Deprecated
@MyNotNullProperty
public IntegerCode getDeprecatedHeader( ) {
return deprecatedHeader;
}
/**
* Method sets attribute {@link #deprecatedHeader}.
*
* @param pDeprecatedHeader Value to which {@link #deprecatedHeader} should be set.
*/
@Deprecated
public void setDeprecatedHeader( @MyNotNullProperty IntegerCode pDeprecatedHeader ) {
// Assign value to attribute
deprecatedHeader = pDeprecatedHeader;
}
/**
* Method returns attribute {@link #deprecatedType}.
*
* @return {@link DeprecatedType} Value to which {@link #deprecatedType} is set.
*/
@MyNotNullProperty
public DeprecatedType getDeprecatedType( ) {
return deprecatedType;
}
/**
* Method sets attribute {@link #deprecatedType}.
*
* @param pDeprecatedType Value to which {@link #deprecatedType} should be set.
*/
public void setDeprecatedType( @MyNotNullProperty DeprecatedType pDeprecatedType ) {
// Assign value to attribute
deprecatedType = pDeprecatedType;
}
/**
* 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.
*/
@Override
public StringBuilder toStringBuilder( String pIndent ) {
StringBuilder lBuilder = super.toStringBuilder(pIndent);
lBuilder.append(pIndent);
lBuilder.append("specificHeader: ");
lBuilder.append(specificHeader);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("deprecatedHeader: ");
lBuilder.append(deprecatedHeader);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("deprecatedType: ");
lBuilder.append(deprecatedType);
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 SpecialContext objects. The method never returns
* null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}