com.anaptecs.spring.base.Partner Maven / Gradle / Ivy

Go to download
/*
 * anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
 * 
 * Copyright 2004 - 2019. All rights reserved.
 */
package com.anaptecs.spring.base;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;

/**
 * @author JEAF Generator
 * @version JEAF Release 1.4.x
 */
public class Partner {
  /**
   * Constant for the name of attribute "postalAddresses".
   */
  public static final String POSTALADDRESSES = "postalAddresses";

  /**
   * 
   */
  private List postalAddresses = new ArrayList();

  /**
   * Default constructor is only intended to be used for deserialization as many frameworks required that. For "normal"
   * object creation builder should be used instead.
   */
  protected Partner( ) {
    // Nothing to do.
  }

  /**
   * Initialize object using the passed builder.
   * 
   * @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
   */
  protected Partner( Builder pBuilder ) {
    // Read attribute values from builder.
    if (pBuilder.postalAddresses != null) {
      postalAddresses.addAll(pBuilder.postalAddresses);
    }
  }

  /**
   * Class implements builder to create a new instance of class Partner. 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 class Builder {
    /**
     * 
     */
    private List postalAddresses;

    /**
     * Use {@link #newBuilder()} instead of private constructor to create new builder.
     */
    protected Builder( ) {
    }

    /**
     * Use {@link #newBuilder(Partner)} instead of private constructor to create new builder.
     */
    protected Builder( Partner pObject ) {
      if (pObject != null) {
        // Read attribute values from passed object.
        postalAddresses = pObject.postalAddresses;
      }
    }

    /**
     * Method returns a new builder.
     * 
     * @return {@link Builder} New builder that can be used to create new ImmutablePOJOParent 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 Partner objects. The method never returns
     * null.
     */
    public static Builder newBuilder( Partner pObject ) {
      return new Builder(pObject);
    }

    /**
     * Method sets the association "postalAddresses".
     * 
     * @param pPostalAddresses Collection with objects to which the association should be set.
     */
    public Builder setPostalAddresses( List pPostalAddresses ) {
      // To ensure immutability we have to copy the content of the passed collection.
      if (pPostalAddresses != null) {
        postalAddresses = new ArrayList(pPostalAddresses);
      }
      else {
        postalAddresses = null;
      }
      return this;
    }

    /**
     * Method creates a new instance of class Partner. The object will be initialized with the values of the builder.
     * 
     * @return Partner Created object. The method never returns null.
     */
    public Partner build( ) {
      return new Partner(this);
    }
  }

  /**
   * Method returns the association "postalAddresses".
   * 
   *
   * @return Collection All PostalAddress objects that belong to the association "postalAddresses". The method never
   * returns null and the returned collection is unmodifiable.
   */
  public List getPostalAddresses( ) {
    // Return all PostalAddress objects as unmodifiable collection.
    return Collections.unmodifiableList(postalAddresses);
  }

  /**
   * Method sets the association "postalAddresses" to the passed collection. All objects that formerly were part of the
   * association will be removed from it.
   * 
   * 
   * @param pPostalAddresses Collection with objects to which the association should be set. The parameter must not be
   * null.
   */
  void setPostalAddresses( List pPostalAddresses ) {
    // Check of parameter is not required.
    // Remove all objects from association "postalAddresses".
    this.clearPostalAddresses();
    // If the association is null, removing all entries is sufficient.
    if (pPostalAddresses != null) {
      postalAddresses = new ArrayList(pPostalAddresses);
    }
  }

  /**
   * Method adds the passed PostalAddress object to the association "postalAddresses".
   * 
   * 
   * @param pPostalAddresses Object that should be added to the association "postalAddresses". The parameter must not be
   * null.
   */
  public void addToPostalAddresses( PostalAddress pPostalAddresses ) {
    // Add passed object to collection of associated PostalAddress objects.
    postalAddresses.add(pPostalAddresses);
  }

  /**
   * Method adds all passed objects to the association "postalAddresses".
   * 
   * 
   * @param pPostalAddresses Collection with all objects that should be added to the association "postalAddresses". The
   * parameter must not be null.
   */
  public void addToPostalAddresses( Collection pPostalAddresses ) {
    // Add all passed objects.
    for (PostalAddress lNextObject : pPostalAddresses) {
      this.addToPostalAddresses(lNextObject);
    }
  }

  /**
   * Method removes the passed PostalAddress object from the association "postalAddresses".
   * 
   * 
   * @param pPostalAddresses Object that should be removed from the association "postalAddresses". The parameter must
   * not be null.
   */
  public void removeFromPostalAddresses( PostalAddress pPostalAddresses ) {
    // Remove passed object from collection of associated PostalAddress objects.
    postalAddresses.remove(pPostalAddresses);
  }

  /**
   * Method removes all objects from the association "postalAddresses".
   * 
   */
  public void clearPostalAddresses( ) {
    // Remove all objects from association "postalAddresses".
    Collection lPostalAddresses = new HashSet(postalAddresses);
    Iterator lIterator = lPostalAddresses.iterator();
    while (lIterator.hasNext()) {
      this.removeFromPostalAddresses(lIterator.next());
    }
  }

  /**
   * 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.
   */
  protected StringBuilder toStringBuilder( ) {
    StringBuilder lBuilder = new StringBuilder();
    lBuilder.append(this.getClass().getName());
    lBuilder.append('\n');
    lBuilder.append("Attributes:");
    lBuilder.append('\n');
    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();
  }
}