org.jclouds.googlecompute.domain.Resource Maven / Gradle / Ivy

Go to download
/*
 * 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.googlecompute.domain;

import com.google.common.annotations.Beta;
import com.google.common.base.CaseFormat;
import com.google.common.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.base.Optional;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
import org.jclouds.javax.annotation.Nullable;

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

import static com.google.common.base.Objects.ToStringHelper;
import static com.google.common.base.Objects.equal;
import static com.google.common.base.Objects.toStringHelper;
import static com.google.common.base.Optional.fromNullable;
import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Base class for Google Compute Engine resources.
 *
 * @author David Alves
 */
@Beta
public class Resource {

   public enum Kind {
      DISK,
      DISK_LIST,
      FIREWALL,
      FIREWALL_LIST,
      IMAGE,
      IMAGE_LIST,
      OPERATION,
      OPERATION_LIST,
      INSTANCE,
      INSTANCE_LIST,
      KERNEL,
      KERNEL_LIST,
      MACHINE_TYPE,
      MACHINE_TYPE_LIST,
      PROJECT,
      NETWORK,
      NETWORK_LIST,
      ZONE,
      ZONE_LIST;

      public String value() {
         return Joiner.on("#").join("compute", CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name()));
      }

      @Override
      public String toString() {
         return value();
      }

      public static Kind fromValue(String kind) {
         return valueOf(CaseFormat.LOWER_CAMEL.to(CaseFormat
                 .UPPER_UNDERSCORE,
                 Iterables.getLast(Splitter.on("#").split(checkNotNull(kind,
                         "kind")))));
      }
   }

   protected final Kind kind;
   protected final String id;
   protected final Optional creationTimestamp;
   protected final URI selfLink;
   protected final String name;
   protected final Optional description;

   @ConstructorProperties({
           "kind", "id", "creationTimestamp", "selfLink", "name", "description"
   })
   protected Resource(Kind kind, String id, Date creationTimestamp, URI selfLink, String name,
                      String description) {
      this.kind = checkNotNull(kind, "kind");
      this.id = checkNotNull(id, "id");
      this.creationTimestamp = fromNullable(creationTimestamp);
      this.selfLink = checkNotNull(selfLink, "selfLink");
      this.name = checkNotNull(name, "name");
      this.description = fromNullable(description);
   }

   /**
    * @return the Type of the resource
    */
   public Kind getKind() {
      return kind;
   }

   /**
    * @return unique identifier for the resource; defined by the server.
    */
   public String getId() {
      return id;
   }

   /**
    * @return creation timestamp in RFC3339 text format.
    */
   public Optional getCreationTimestamp() {
      return creationTimestamp;
   }

   /**
    * @return server defined URL for the resource.
    */
   public URI getSelfLink() {
      return selfLink;
   }

   /**
    * @return name of the resource.
    */
   public String getName() {
      return name;
   }

   /**
    * @return an optional textual description of the resource.
    */
   @Nullable
   public Optional getDescription() {
      return description;
   }

   /**
    * {@inheritDoc}
    */
   @Override
   public int hashCode() {
      return Objects.hashCode(kind, name);
   }

   /**
    * {@inheritDoc}
    */
   @Override
   public boolean equals(Object obj) {
      if (this == obj) return true;
      if (obj == null || getClass() != obj.getClass()) return false;
      Resource that = Resource.class.cast(obj);
      return equal(this.kind, that.kind)
              && equal(this.name, that.name);
   }

   /**
    * {@inheritDoc}
    */
   protected ToStringHelper string() {
      return toStringHelper(this)
              .omitNullValues()
              .add("kind", kind)
              .add("id", id)
              .add("name", name)
              .add("creationTimestamp", creationTimestamp.orNull())
              .add("selfLink", selfLink)
              .add("name", name)
              .add("description", description.orNull());
   }

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

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

   public Builder toBuilder() {
      return new ConcreteBuilder().fromResource(this);
   }

   public abstract static class Builder> {

      protected abstract T self();

      protected Kind kind;
      protected String id;
      protected Date creationTimestamp;
      protected URI selfLink;
      protected String name;
      protected String description;

      /**
       * @see Resource#getKind()
       */
      protected T kind(Kind kind) {
         this.kind = kind;
         return self();
      }

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

      /**
       * @see Resource#getCreationTimestamp()
       */
      public T creationTimestamp(Date creationTimestamp) {
         this.creationTimestamp = creationTimestamp;
         return self();
      }

      /**
       * @see Resource#getSelfLink()
       */
      public T selfLink(URI selfLink) {
         this.selfLink = selfLink;
         return self();
      }

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

      /**
       * @see Resource#getDescription()
       */
      public T description(String description) {
         this.description = description;
         return self();
      }

      public Resource build() {
         return new Resource(kind, id, creationTimestamp, selfLink, name, description);
      }

      public T fromResource(Resource in) {
         return this
                 .kind(in.getKind())
                 .id(in.getId())
                 .creationTimestamp(in.getCreationTimestamp().orNull())
                 .selfLink(in.getSelfLink())
                 .name(in.getName())
                 .description(in.getDescription().orNull());
      }
   }

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