labs/glesys/src/main/java/org/jclouds/glesys/domain/EmailOverview.java

/**
 * Licensed to jclouds, Inc. (jclouds) under one or more
 * contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  jclouds licenses this file
 * to you 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 org.jclouds.glesys.domain;

import java.util.Set;

import com.google.common.annotations.Beta;
import com.google.common.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableSet;

/**
 * Structure containing all information about e-mail addresses for a GleSYS account
 * 
 * @author Adam Lowe
 * @see <a href="https://customer.glesys.com/api.php?a=doc#email_overview" />
 */
//TODO: find a better name for this class
@Beta
public class EmailOverview {
   public static Builder builder() {
      return new Builder();
   }

   public static class Builder {
      private EmailOverviewSummary summary;
      private Set<EmailOverviewDomain> domains;

      public Builder summary(EmailOverviewSummary summary) {
         this.summary = summary;
         return this;
      }

      public Builder domains(Set<EmailOverviewDomain> domains) {
         this.domains = domains;
         return this;
      }

      public Builder domains(EmailOverviewDomain... domains) {
         return domains(ImmutableSet.copyOf(domains));
      }

      public EmailOverview build() {
         return new EmailOverview(summary, domains);
      }
      
      public Builder fromEmailOverview(EmailOverview in) {
         return summary(in.getSummary()).domains(in.getDomains());
      }
   }

   private EmailOverviewSummary summary;
   private Set<EmailOverviewDomain> domains;

   public EmailOverview(EmailOverviewSummary summary,  Set<EmailOverviewDomain> domains) {
      this.summary = summary; 
      this.domains = domains;
   }

   /** @return summary information about the account */
   public EmailOverviewSummary getSummary() {
      return summary;
   }

   /** @return the set of detailed information about the e-mail addresses and aliases for each domain */
   public Set<EmailOverviewDomain> getDomains() {
      return domains == null ? ImmutableSet.<EmailOverviewDomain>of() : domains;
   }

   @Override
   public int hashCode() {
      return Objects.hashCode(summary, domains);
   }

   @Override
   public boolean equals(Object object) {
      if (object == this) {
         return true;
      }
      if (object instanceof EmailOverview) {
         EmailOverview other = (EmailOverview) object;
         return Objects.equal(summary, other.summary)
               && Objects.equal(domains, other.domains);
      } else {
         return false;
      }
   }

   @Override
   public String toString() {
      Joiner commaJoiner = Joiner.on(", ");
      return String.format("summary=%s, domains=[%s]", summary, commaJoiner.join(getDomains()));
   }

}