All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.anaptecs.jeaf.junit.rest.generics.GenericPageableResponseBase Maven / Gradle / Ivy

There is a newer version: 1.24.1
Show newest version
/*
 * anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
 *
 * Copyright 2004 - 2021. All rights reserved.
 */
package com.anaptecs.jeaf.junit.rest.generics;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;

import javax.validation.ConstraintViolationException;
import javax.validation.Valid;

import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.checks.Check;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;

@Valid
public abstract class GenericPageableResponseBase extends AbstractResponse {
  /**
   * Default serial version uid.
   */
  private static final long serialVersionUID = 1L;

  @JsonSetter(nulls = Nulls.SKIP)
  private List values;

  /**
   * 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 GenericPageableResponseBase( ) {
    values = new ArrayList();
  }

  /**
   * Initialize object using the passed builder.
   *
   * @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
   */
  protected GenericPageableResponseBase( BuilderBase pBuilder ) {
    // Call constructor of super class.
    super(pBuilder);
    // Read attribute values from builder.
    if (pBuilder.values != null) {
      values = pBuilder.values;
    }
    else {
      values = new ArrayList();
    }
  }

  /**
   * Class implements builder to create a new instance of class GenericPageableResponse. As the class has read only
   * attributes or associations instances can not be created directly. Instead this builder class has to be used.
   */
  public static abstract class BuilderBase extends AbstractResponse.Builder {
    private List values;

    /**
     * Use {@link GenericPageableResponse.builder()} instead of protected constructor to create new builder.
     */
    protected BuilderBase( ) {
    }

    /**
     * Use {@link GenericPageableResponse.builder(GenericPageableResponse)} instead of protected constructor to create
     * new builder.
     */
    protected BuilderBase( GenericPageableResponseBase pObject ) {
      if (pObject != null) {
        // Read attribute values from passed object.
        this.setValues(pObject.values);
      }
    }

    /**
     * Method sets association {@link #errors}.
* * @param pErrors Collection to which {@link #errors} should be set. * @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null. */ @Override public BuilderBase setErrors( List pErrors ) { // Call super class implementation. super.setErrors(pErrors); return this; } /** * Method adds the passed objects to association {@link #errors}.
* * @param pErrors Array of objects that should be added to {@link #errors}. The parameter may be null. * @return {@link BuilderBase} Instance of this builder to support chaining. Method never returns null. */ public BuilderBase addToErrors( Message... pErrors ) { // Call super class implementation. super.addToErrors(pErrors); return this; } /** * Method sets association {@link #warnings}.
* * @param pWarnings Collection to which {@link #warnings} should be set. * @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null. */ @Override public BuilderBase setWarnings( List pWarnings ) { // Call super class implementation. super.setWarnings(pWarnings); return this; } /** * Method adds the passed objects to association {@link #warnings}.
* * @param pWarnings Array of objects that should be added to {@link #warnings}. The parameter may be null. * @return {@link BuilderBase} Instance of this builder to support chaining. Method never returns null. */ public BuilderBase addToWarnings( Message... pWarnings ) { // Call super class implementation. super.addToWarnings(pWarnings); return this; } /** * Method sets association {@link #values}.
* * @param pValues Collection to which {@link #values} should be set. * @return {@link BuilderBase} Instance of this builder to support chaining setters. Method never returns null. */ public BuilderBase setValues( List pValues ) { // To ensure immutability we have to copy the content of the passed collection. if (pValues != null) { values = new ArrayList(pValues); } else { values = null; } return this; } /** * Method adds the passed objects to association {@link #values}.
* * @param pValues Array of objects that should be added to {@link #values}. The parameter may be null. * @return {@link BuilderBase} Instance of this builder to support chaining. Method never returns null. */ public BuilderBase addToValues( @SuppressWarnings("unchecked") T... pValues ) { if (pValues != null) { if (values == null) { values = new ArrayList(); } values.addAll(Arrays.asList(pValues)); } return this; } /** * Method creates a new instance of class GenericPageableResponse. The object will be initialized with the values of * the builder. * * @return GenericPageableResponse Created object. The method never returns null. */ public GenericPageableResponse build( ) { return new GenericPageableResponse(this); } /** * Method creates a new validated instance of class GenericPageableResponse. The object will be initialized with the * values of the builder and validated afterwards. * * @return GenericPageableResponse Created and validated object. The method never returns null. * @throws ConstraintViolationException in case that one or more validations for the created object failed. */ public GenericPageableResponse buildValidated( ) throws ConstraintViolationException { GenericPageableResponse lPOJO = this.build(); ValidationTools.getValidationTools().enforceObjectValidation(lPOJO); return lPOJO; } } /** * Method returns association {@link #values}.
* * @return {@link List} Value to which {@link #values} is set. The method never returns null and the returned * collection is modifiable. */ public List getValues( ) { // Return all T objects directly without any protection against modification. return values; } /** * Method adds the passed object to {@link #values}. * * @param pValues Object that should be added to {@link #values}. The parameter must not be null. */ public void addToValues( T pValues ) { // Check parameter "pValues" for invalid value null. Check.checkInvalidParameterNull(pValues, "pValues"); // Add passed object to collection of associated T objects. values.add(pValues); } /** * Method adds all passed objects to {@link #values}. * * @param pValues Collection with all objects that should be added to {@link #values}. The parameter must not be null. */ public void addToValues( Collection pValues ) { // Check parameter "pValues" for invalid value null. Check.checkInvalidParameterNull(pValues, "pValues"); // Add all passed objects. for (T lNextObject : pValues) { this.addToValues(lNextObject); } } /** * Method removes the passed object from {@link #values}.
* * @param pValues Object that should be removed from {@link #values}. The parameter must not be null. */ public void removeFromValues( T pValues ) { // Check parameter for invalid value null. Check.checkInvalidParameterNull(pValues, "pValues"); // Remove passed object from collection of associated T objects. values.remove(pValues); } /** * Method removes all objects from {@link #values}. */ public void clearValues( ) { // Remove all objects from association "values". values.clear(); } /** * 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("values: "); if (values != null) { lBuilder.append(values.size()); lBuilder.append(" element(s)"); } else { lBuilder.append(" null"); } lBuilder.append(System.lineSeparator()); if (values != null) { for (T lNext : values) { lBuilder.append(pIndent + " "); lBuilder.append(lNext.toString()); 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 GenericPageableResponse objects. The method * never returns null. */ public GenericPageableResponse.Builder toBuilder( ) { return new GenericPageableResponse.Builder((GenericPageableResponse) this); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy