apis/cloudstack/src/main/java/org/jclouds/cloudstack/domain/DiskOffering.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.cloudstack.domain;

import static com.google.common.base.Preconditions.checkNotNull;

import java.beans.ConstructorProperties;
import java.util.Date;

import javax.inject.Named;

import org.jclouds.javax.annotation.Nullable;

import com.google.common.base.Objects;
import com.google.common.base.Objects.ToStringHelper;

/**
 * Class DiskOffering
 *
 * @author Adrian Cole
 */
public class DiskOffering implements Comparable<DiskOffering> {

   public static Builder<?> builder() {
      return new ConcreteBuilder();
   }

   public Builder<?> toBuilder() {
      return new ConcreteBuilder().fromDiskOffering(this);
   }

   public static abstract class Builder<T extends Builder<T>>  {
      protected abstract T self();

      protected String id;
      protected String name;
      protected String displayText;
      protected Date created;
      protected String domain;
      protected String domainId;
      protected int diskSize;
      protected boolean customized;
      protected String tags;

      /**
       * @see DiskOffering#getId()
       */
      public T id(String id) {
         this.id = id;
         return self();
      }

      /**
       * @see DiskOffering#getName()
       */
      public T name(String name) {
         this.name = name;
         return self();
      }

      /**
       * @see DiskOffering#getDisplayText()
       */
      public T displayText(String displayText) {
         this.displayText = displayText;
         return self();
      }

      /**
       * @see DiskOffering#getCreated()
       */
      public T created(Date created) {
         this.created = created;
         return self();
      }

      /**
       * @see DiskOffering#getDomain()
       */
      public T domain(String domain) {
         this.domain = domain;
         return self();
      }

      /**
       * @see DiskOffering#getDomainId()
       */
      public T domainId(String domainId) {
         this.domainId = domainId;
         return self();
      }

      /**
       * @see DiskOffering#getDiskSize()
       */
      public T diskSize(int diskSize) {
         this.diskSize = diskSize;
         return self();
      }

      /**
       * @see DiskOffering#isCustomized()
       */
      public T customized(boolean customized) {
         this.customized = customized;
         return self();
      }

      /**
       * @see DiskOffering#getTags()
       */
      public T tags(String tags) {
         this.tags = tags;
         return self();
      }

      public DiskOffering build() {
         return new DiskOffering(id, name, displayText, created, domain, domainId, diskSize, customized, tags);
      }

      public T fromDiskOffering(DiskOffering in) {
         return this
               .id(in.getId())
               .name(in.getName())
               .displayText(in.getDisplayText())
               .created(in.getCreated())
               .domain(in.getDomain())
               .domainId(in.getDomainId())
               .diskSize(in.getDiskSize())
               .customized(in.isCustomized())
               .tags(in.getTags());
      }
   }

   private static class ConcreteBuilder extends Builder<ConcreteBuilder> {
      @Override
      protected ConcreteBuilder self() {
         return this;
      }
   }

   private final String id;
   private final String name;
   @Named("displaytext")
   private final String displayText;
   private final Date created;
   private final String domain;
   @Named("domainid")
   private final String domainId;
   @Named("disksize")
   private final int diskSize;
   @Named("iscustomized")
   private final boolean customized;
   private final String tags;

   @ConstructorProperties({
         "id", "name", "displaytext", "created", "domain", "domainid", "disksize", "iscustomized", "tags"
   })
   protected DiskOffering(String id, @Nullable String name, @Nullable String displayText, @Nullable Date created,
                          @Nullable String domain, @Nullable String domainId, int diskSize, boolean customized,
                          @Nullable String tags) {
      this.id = checkNotNull(id, "id");
      this.name = name;
      this.displayText = displayText;
      this.created = created;
      this.domain = domain;
      this.domainId = domainId;
      this.diskSize = diskSize;
      this.customized = customized;
      this.tags = tags;
   }

   /**
    * @return the id of the disk offering
    */
   public String getId() {
      return this.id;
   }

   /**
    * @return the name of the disk offering
    */
   @Nullable
   public String getName() {
      return this.name;
   }

   /**
    * @return an alternate display text of the disk offering.
    */
   @Nullable
   public String getDisplayText() {
      return this.displayText;
   }

   /**
    * @return the date this disk offering was created
    */
   @Nullable
   public Date getCreated() {
      return this.created;
   }

   /**
    * @return Domain name for the offering
    */
   @Nullable
   public String getDomain() {
      return this.domain;
   }

   /**
    * @return the domain id of the disk offering
    */
   @Nullable
   public String getDomainId() {
      return this.domainId;
   }

   /**
    * @return the size of the disk offering in GB
    */
   public int getDiskSize() {
      return this.diskSize;
   }

   /**
    * @return the ha support in the disk offering
    */
   public boolean isCustomized() {
      return this.customized;
   }

   /**
    * @return the tags for the disk offering
    */
   @Nullable
   public String getTags() {
      return this.tags;
   }

   @Override
   public int hashCode() {
      return Objects.hashCode(id, name, displayText, created, domain, domainId, diskSize, customized, tags);
   }

   @Override
   public boolean equals(Object obj) {
      if (this == obj) return true;
      if (obj == null || getClass() != obj.getClass()) return false;
      DiskOffering that = DiskOffering.class.cast(obj);
      return Objects.equal(this.id, that.id)
            && Objects.equal(this.name, that.name)
            && Objects.equal(this.displayText, that.displayText)
            && Objects.equal(this.created, that.created)
            && Objects.equal(this.domain, that.domain)
            && Objects.equal(this.domainId, that.domainId)
            && Objects.equal(this.diskSize, that.diskSize)
            && Objects.equal(this.customized, that.customized)
            && Objects.equal(this.tags, that.tags);
   }

   protected ToStringHelper string() {
      return Objects.toStringHelper(this)
            .add("id", id).add("name", name).add("displayText", displayText).add("created", created).add("domain", domain)
            .add("domainId", domainId).add("diskSize", diskSize).add("customized", customized).add("tags", tags);
   }

   @Override
   public String toString() {
      return string().toString();
   }

   @Override
   public int compareTo(DiskOffering other) {
      return id.compareTo(other.getId());
   }

}