com.helger.peppol.businesscard.generic.PDContact Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of peppol-directory-businesscard Show documentation
The Peppol Directory Business Card data model
There is a newer version: 9.7.1
Show newest version
/*
 * Copyright (C) 2015-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.peppol.businesscard.generic;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.lang.ICloneable;
import com.helger.commons.string.ToStringGenerator;
import com.helger.json.IHasJson;
import com.helger.json.IJsonObject;
import com.helger.json.JsonObject;
import com.helger.xml.microdom.IMicroElement;
import com.helger.xml.microdom.MicroElement;

/**
 * Generic contact.
 *
 * @author Philip Helger
 */
@NotThreadSafe
public class PDContact implements IHasJson, Serializable, ICloneable 
{
  private String m_sType;
  private String m_sName;
  private String m_sPhoneNumber;
  private String m_sEmail;

  public PDContact ()
  {}

  public PDContact (@Nullable final String sType,
                    @Nullable final String sName,
                    @Nullable final String sPhoneNumber,
                    @Nullable final String sEmail)
  {
    setType (sType);
    setName (sName);
    setPhoneNumber (sPhoneNumber);
    setEmail (sEmail);
  }

  /**
   * Gets the value of the type property.
   *
   * @return The contact type. Maybe null.
   */
  @Nullable
  public final String getType ()
  {
    return m_sType;
  }

  /**
   * Sets the value of the type property.
   *
   * @param sType
   *        The contact type. Maybe null.
   * @return this for chaining
   */
  @Nonnull
  public final PDContact setType (@Nullable final String sType)
  {
    m_sType = sType;
    return this;
  }

  /**
   * Gets the value of the name property.
   *
   * @return The contact name. Maybe null.
   */
  @Nullable
  public final String getName ()
  {
    return m_sName;
  }

  /**
   * Sets the value of the name property.
   *
   * @param sName
   *        The contact name. Maybe null.
   * @return this for chaining
   */
  @Nonnull
  public final PDContact setName (@Nullable final String sName)
  {
    m_sName = sName;
    return this;
  }

  /**
   * Gets the value of the phoneNumber property.
   *
   * @return The contact phone number. Maybe null.
   */
  @Nullable
  public final String getPhoneNumber ()
  {
    return m_sPhoneNumber;
  }

  /**
   * Sets the value of the phoneNumber property.
   *
   * @param sPhoneNumber
   *        The contact phone number. Maybe null.
   * @return this for chaining
   */
  @Nonnull
  public final PDContact setPhoneNumber (@Nullable final String sPhoneNumber)
  {
    m_sPhoneNumber = sPhoneNumber;
    return this;
  }

  /**
   * Gets the value of the email property.
   *
   * @return The contact email address. May be null.
   */
  @Nullable
  public final String getEmail ()
  {
    return m_sEmail;
  }

  /**
   * Sets the value of the email property.
   *
   * @param sEmail
   *        The contact email address to use. May be null.
   * @return this for chaining
   */
  @Nonnull
  public final PDContact setEmail (@Nullable final String sEmail)
  {
    m_sEmail = sEmail;
    return this;
  }

  /**
   * This method clones all values from this to the passed object.
   * All data in the parameter object is overwritten!
   *
   * @param ret
   *        The target object to clone to. May not be null.
   */
  public void cloneTo (@Nonnull final PDContact ret)
  {
    ret.m_sType = m_sType;
    ret.m_sName = m_sName;
    ret.m_sPhoneNumber = m_sPhoneNumber;
    ret.m_sEmail = m_sEmail;
  }

  @Nonnull
  @ReturnsMutableCopy
  public PDContact getClone ()
  {
    final PDContact ret = new PDContact ();
    cloneTo (ret);
    return ret;
  }

  @Nonnull
  public IMicroElement getAsMicroXML (@Nullable final String sNamespaceURI, @Nonnull @Nonempty final String sElementName)
  {
    final IMicroElement ret = new MicroElement (sNamespaceURI, sElementName);
    ret.setAttribute ("type", m_sType);
    ret.setAttribute ("name", m_sName);
    ret.setAttribute ("phonenumber", m_sPhoneNumber);
    ret.setAttribute ("email", m_sEmail);
    return ret;
  }

  @Nonnull
  public IJsonObject getAsJson ()
  {
    final IJsonObject ret = new JsonObject ();
    ret.add ("type", m_sType);
    ret.add ("name", m_sName);
    ret.add ("phonenumber", m_sPhoneNumber);
    ret.add ("email", m_sEmail);
    return ret;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;

    final PDContact rhs = (PDContact) o;
    return EqualsHelper.equals (m_sType, rhs.m_sType) &&
           EqualsHelper.equals (m_sName, rhs.m_sName) &&
           EqualsHelper.equals (m_sPhoneNumber, rhs.m_sPhoneNumber) &&
           EqualsHelper.equals (m_sEmail, rhs.m_sEmail);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_sType).append (m_sName).append (m_sPhoneNumber).append (m_sEmail).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("type", m_sType)
                                       .append ("name", m_sName)
                                       .append ("phoneNumber", m_sPhoneNumber)
                                       .append ("email", m_sEmail)
                                       .getToString ();
  }

  @Nullable
  public static PDContact of (@Nullable final IJsonObject aJson)
  {
    return aJson == null ? null
                         : new PDContact (aJson.getAsString ("type"),
                                          aJson.getAsString ("name"),
                                          aJson.getAsString ("phonenumber"),
                                          aJson.getAsString ("email"));
  }
}