com.anaptecs.spring.base.Problem Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.spring.base;
import javax.validation.constraints.NotNull;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown = true)
public class Problem {
/**
* Constant for the name of attribute "title".
*/
public static final String TITLE = "title";
/**
* Constant for the name of attribute "status".
*/
public static final String STATUS = "status";
/**
* Constant for the name of attribute "type".
*/
public static final String TYPE = "type";
/**
* Constant for the name of attribute "detail".
*/
public static final String DETAIL = "detail";
/**
* Constant for the name of attribute "instance".
*/
public static final String INSTANCE = "instance";
@NotNull
private final String title;
@NotNull
public final int status;
@NotNull
private final String type;
private final String detail;
private final String instance;
/**
* 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 Problem( ) {
title = null;
status = 0;
type = null;
detail = null;
instance = 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 Problem( Builder pBuilder ) {
// Read attribute values from builder.
title = pBuilder.title;
status = pBuilder.status;
type = pBuilder.type;
detail = pBuilder.detail;
instance = pBuilder.instance;
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new Problem objects.
*/
public static Builder builder( ) {
return new Builder();
}
/**
* Convenience method to create new instance of class Problem.
*
*
* @param pTitle Value to which {@link #title} should be set.
*
* @param pStatus Value to which {@link #status} should be set.
*
* @param pType Value to which {@link #type} should be set.
*
* @param pDetail Value to which {@link #detail} should be set.
*
* @param pInstance Value to which {@link #instance} should be set.
*
* @return {@link com.anaptecs.spring.base.Problem}
*/
public static Problem of( String pTitle, int pStatus, String pType, String pDetail, String pInstance ) {
Problem.Builder lBuilder = Problem.builder();
lBuilder.setTitle(pTitle);
lBuilder.setStatus(pStatus);
lBuilder.setType(pType);
lBuilder.setDetail(pDetail);
lBuilder.setInstance(pInstance);
return lBuilder.build();
}
/**
* Class implements builder to create a new instance of class Problem.
*/
public static class Builder {
@NotNull
private String title;
@NotNull
private int status;
@NotNull
private String type;
private String detail;
private String instance;
/**
* Use {@link Problem#builder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link Problem#builder(Problem)} instead of private constructor to create new builder.
*/
protected Builder( Problem pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
this.setTitle(pObject.title);
this.setStatus(pObject.status);
this.setType(pObject.type);
this.setDetail(pObject.detail);
this.setInstance(pObject.instance);
}
}
/**
* Method sets attribute {@link #title}.
*
* @param pTitle Value to which {@link #title} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setTitle( String pTitle ) {
// Assign value to attribute
title = pTitle;
return this;
}
/**
* Method sets attribute {@link #status}.
*
* @param pStatus Value to which {@link #status} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setStatus( int pStatus ) {
// Assign value to attribute
status = pStatus;
return this;
}
/**
* Method sets attribute {@link #type}.
*
* @param pType Value to which {@link #type} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setType( String pType ) {
// Assign value to attribute
type = pType;
return this;
}
/**
* Method sets attribute {@link #detail}.
*
* @param pDetail Value to which {@link #detail} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setDetail( String pDetail ) {
// Assign value to attribute
detail = pDetail;
return this;
}
/**
* Method sets attribute {@link #instance}.
*
* @param pInstance Value to which {@link #instance} should be set.
* @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
*/
public Builder setInstance( String pInstance ) {
// Assign value to attribute
instance = pInstance;
return this;
}
/**
* Method creates a new instance of class Problem. The object will be initialized with the values of the builder.
*
* @return Problem Created object. The method never returns null.
*/
public Problem build( ) {
return new Problem(this);
}
}
/**
* Method returns attribute {@link #title}.
*
* @return {@link String} Value to which {@link #title} is set.
*/
public String getTitle( ) {
return title;
}
/**
* Method returns attribute {@link #status}.
*
* @return int Value to which {@link #status} is set.
*/
public int getStatus( ) {
return status;
}
/**
* Method returns attribute {@link #type}.
*
* @return {@link String} Value to which {@link #type} is set.
*/
public String getType( ) {
return type;
}
/**
* Method returns attribute {@link #detail}.
*
* @return {@link String} Value to which {@link #detail} is set.
*/
public String getDetail( ) {
return detail;
}
/**
* Method returns attribute {@link #instance}.
*
* @return {@link String} Value to which {@link #instance} is set.
*/
public String getInstance( ) {
return instance;
}
/**
* 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("title: ");
lBuilder.append(title);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("status: ");
lBuilder.append(status);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("type: ");
lBuilder.append(type);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("detail: ");
lBuilder.append(detail);
lBuilder.append(System.lineSeparator());
lBuilder.append(pIndent);
lBuilder.append("instance: ");
lBuilder.append(instance);
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 Problem objects. The method never returns null.
*/
public Builder toBuilder( ) {
return new Builder(this);
}
}