/*
    * Copyright (C) 2012 Atlassian
    *
    * 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.atlassian.jira.rest.client.api.domain;
  
  import com.atlassian.jira.rest.client.api.IdentifiableEntity;
  import com.atlassian.jira.rest.client.api.NamedEntity;
  import com.google.common.base.Objects;
  
  import javax.annotation.Nullable;
  
  /**
   * Representation of JIRA field, either system or custom.
   */
  public class Field implements NamedEntity, IdentifiableEntity<String> {
  
      private final String id;
      private final String name;
      private final FieldType fieldType;
      private final boolean orderable;
      private final boolean navigable;
      private final boolean searchable;
      @Nullable
      private final FieldSchema schema;
  
      public Field(String id, String name, FieldType fieldType, boolean orderable, boolean navigable, boolean searchable,
                   @Nullable FieldSchema schema) {
          this.id = id;
          this.name = name;
          this.fieldType = fieldType;
          this.orderable = orderable;
          this.navigable = navigable;
          this.searchable = searchable;
          this.schema = schema;
      }
  
      public String getId() {
          return id;
      }
  
      public String getName() {
          return name;
      }
  
      @SuppressWarnings("unused")
      public FieldType getFieldType() {
          return fieldType;
      }
  
      @SuppressWarnings("unused")
      public boolean isOrderable() {
          return orderable;
      }
  
      @SuppressWarnings("unused")
      public boolean isNavigable() {
          return navigable;
      }
  
      @SuppressWarnings("unused")
      public boolean isSearchable() {
          return searchable;
      }
  
      @Nullable
      @SuppressWarnings("unused")
      public FieldSchema getSchema() {
          return schema;
      }
  
      @Override
      public int hashCode() {
          return Objects.hashCode(id, name, fieldType, orderable, navigable, searchable, schema);
      }
  
      @Override
      public boolean equals(Object obj) {
          if (obj instanceof Field) {
              final Field that = (Field) obj;
              return Objects.equal(this.id, that.id)
                      && Objects.equal(this.name, that.name)
                      && Objects.equal(this.fieldType, that.fieldType)
                      && Objects.equal(this.orderable, that.orderable)
                      && Objects.equal(this.navigable, that.navigable)
                      && Objects.equal(this.searchable, that.searchable)
                      && Objects.equal(this.schema, that.schema);
          }
         return false;
     }
 
     protected Objects.ToStringHelper getToStringHelper() {
         return Objects.toStringHelper(this)
                 .add("id", id)
                 .add("name", name)
                 .add("fieldType", fieldType)
                 .add("orderable", orderable)
                 .add("navigable", navigable)
                 .add("searchable", searchable)
                 .add("schema", schema);
     }
 
     @Override
     public String toString() {
         return getToStringHelper().toString();
     }
 }