com.helger.masterdata.email.IMutableExtendedEmailAddress Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 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.masterdata.email;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.lang.ICloneable;
import com.helger.commons.state.EChange;

/**
 * Extended interface for an email address with a type.
 *
 * @author Philip Helger
 */
public interface IMutableExtendedEmailAddress extends IExtendedEmailAddress, ICloneable 
{
  /**
   * @param aAddressType
   *        The type of the email address. May be null.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setType (@Nullable IEmailAddressType aAddressType);

  /**
   * @param sAddress
   *        The main email address. May be null.
   * @return {@link EChange#CHANGED} if the passed email address
   *         was valid and set, {@link EChange#UNCHANGED}
   *         otherwise.
   */
  @Nonnull
  EChange setAddress (@Nullable String sAddress);

  /**
   * @param sPersonal
   *        The personal name. May be null.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setPersonal (@Nullable String sPersonal);
}