com.anaptecs.jeaf.junit.openapi.base.BeanParameter 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 javax.ws.rs.QueryParam;
import com.anaptecs.annotations.MyNotNullProperty;
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 BeanParameter implements ServiceObject {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
@HeaderParam("token")
@NotNull
private String accessToken;
@HeaderParam("lang")
@NotNull
private Locale language;
@Deprecated
@QueryParam("q2")
@NotNull
private String oldStyle;
/**
* 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 BeanParameter( ) {
}
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected BeanParameter( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read attribute values from builder.
accessToken = pBuilder.accessToken;
language = pBuilder.language;
oldStyle = pBuilder.oldStyle;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new BeanParameter objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class BeanParameter.
*
*
* @param pAccessToken Value to which {@link #accessToken} should be set.
*
* @param pLanguage Value to which {@link #language} should be set.
*
* @param pOldStyle Value to which {@link #oldStyle} should be set.
*
* @return {@link com.anaptecs.jeaf.junit.openapi.base.BeanParameter}
*/
public static BeanParameter of( String pAccessToken, Locale pLanguage, String pOldStyle ) {
BeanParameter.Builder lBuilder = BeanParameter.builder();
lBuilder.setAccessToken(pAccessToken);
lBuilder.setLanguage(pLanguage);
lBuilder.setOldStyle(pOldStyle);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class BeanParameter.
*/
public static class Builder {
private String accessToken;
private Locale language;
@Deprecated
private String oldStyle;
/**
* Use {@link BeanParameter#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link BeanParameter#builder(BeanParameter)} instead of private constructor to create new builder.
*/
protected Builder( BeanParameter pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setAccessToken(pObject.accessToken);
this.setLanguage(pObject.language);
this.setOldStyle(pObject.oldStyle);
}
}
/**
* 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.
*/
public Builder setAccessToken( @MyNotNullProperty String pAccessToken ) {
// Assign value to attribute
accessToken = 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.
*/
public Builder setLanguage( @MyNotNullProperty Locale pLanguage ) {
// Assign value to attribute
language = pLanguage;
return this;
}
/**
* Method sets attribute {@link #oldStyle}.
*
* @param pOldStyle Value to which {@link #oldStyle} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
@Deprecated
public Builder setOldStyle( @MyNotNullProperty String pOldStyle ) {
// Assign value to attribute
oldStyle = pOldStyle;
return this;
}
/**
* Method creates a new instance of class BeanParameter. The object will be initialized with the values of the
* builder.
*
* @return BeanParameter Created object. The method never returns null.
*/
public BeanParameter build( ) {
return new BeanParameter(this);
}
/**
* Method creates a new validated instance of class BeanParameter. The object will be initialized with the values of
* the builder and validated afterwards.
*
* @return BeanParameter Created and validated object. The method never returns null.
* @throws ConstraintViolationException in case that one or more validations for the created object failed.
*/
public BeanParameter buildValidated( ) throws ConstraintViolationException {
BeanParameter lObject = this.build();
ValidationTools.getValidationTools().enforceObjectValidation(lObject);
return lObject;
}
}
/**
* Method returns attribute {@link #accessToken}.
*
* @return {@link String} Value to which {@link #accessToken} is set.
*/
@MyNotNullProperty
public String getAccessToken( ) {
return accessToken;
}
/**
* Method sets attribute {@link #accessToken}.
*
* @param pAccessToken Value to which {@link #accessToken} should be set.
*/
public void setAccessToken( @MyNotNullProperty String pAccessToken ) {
// Assign value to attribute
accessToken = pAccessToken;
}
/**
* Method returns attribute {@link #language}.
*
* @return {@link Locale} Value to which {@link #language} is set.
*/
@MyNotNullProperty
public Locale getLanguage( ) {
return language;
}
/**
* Method sets attribute {@link #language}.
*
* @param pLanguage Value to which {@link #language} should be set.
*/
public void setLanguage( @MyNotNullProperty Locale pLanguage ) {
// Assign value to attribute
language = pLanguage;
}
/**
* Method returns attribute {@link #oldStyle}.
*
* @return {@link String} Value to which {@link #oldStyle} is set.
*/
@Deprecated
@MyNotNullProperty
public String getOldStyle( ) {
return oldStyle;
}
/**
* Method sets attribute {@link #oldStyle}.
*
* @param pOldStyle Value to which {@link #oldStyle} should be set.
*/
@Deprecated
public void setOldStyle( @MyNotNullProperty String pOldStyle ) {
// Assign value to attribute
oldStyle = pOldStyle;
}
/**
* 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("accessToken: ");
lBuilder.append(accessToken);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("language: ");
lBuilder.append(language);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("oldStyle: ");
lBuilder.append(oldStyle);
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 BeanParameter objects. The method never returns
* null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}