/**
    *
    * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.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 org.jclouds.vcloud.domain.network.firewall;
  
  import static com.google.common.base.Preconditions.checkNotNull;
  
  import javax.annotation.Nullable;
  
  /**
   * The FirewallRule element defines a single firewall rule.
   * 
   * @author Adrian Cole
   * @since vcloud api 0.8
   */
  public class FirewallRule {
  
     private final boolean enabled;
     @Nullable
     private final String description;
     @Nullable
     private final FirewallPolicy policy;
     @Nullable
     private final FirewallProtocols protocols;
     private final int port;
     private final String destinationIp;
  
     public FirewallRule(boolean enabled, @Nullable String description, @Nullable FirewallPolicy policy,
              @Nullable FirewallProtocols protocols, int port, String destinationIp) {
        this.enabled = enabled;
        this.description = description;
        this.policy = policy;
        this.protocols = protocols;
        this.port = port;
        this.destinationIp = checkNotNull(destinationIp, "destinationIp");
     }
  
     /**
      * @return true if the rule is enabled
      */
     public boolean isEnabled() {
        return enabled;
     }
  
     /**
      * @return description of the rule
      */
     @Nullable
     public String getDescription() {
        return description;
     }
  
     /**
      * @return specifies how packets are handled by the firewall
      */
     @Nullable
     public FirewallPolicy getPolicy() {
        return policy;
     }
  
     /**
      * @return specifies the protocols to which this firewall rule applies
      */
     @Nullable
     public FirewallProtocols getProtocols() {
        return protocols;
     }
  
     /**
      * @return specifies the network port to which this firewall rule applies. A value of ‐1 matches
      *         any port.
      */
     public int getPort() {
        return port;
     }
  
     /**
      * @return specifies the destination IP address, inside the firewall, to which this firewall rule
      *         applies
      */
     public String getDestinationIp() {
        return destinationIp;
     }
  
    @Override
    public int hashCode() {
       final int prime = 31;
       int result = 1;
       result = prime * result + ((description == null) ? 0 : description.hashCode());
       result = prime * result + ((destinationIp == null) ? 0 : destinationIp.hashCode());
       result = prime * result + (enabled ? 1231 : 1237);
       result = prime * result + ((policy == null) ? 0 : policy.hashCode());
       result = prime * result + port;
       result = prime * result + ((protocols == null) ? 0 : protocols.hashCode());
       return result;
    }
 
    @Override
    public boolean equals(Object obj) {
       if (this == obj)
          return true;
       if (obj == null)
          return false;
       if (getClass() != obj.getClass())
          return false;
       FirewallRule other = (FirewallRule) obj;
       if (description == null) {
          if (other.description != null)
             return false;
       } else if (!description.equals(other.description))
          return false;
       if (destinationIp == null) {
          if (other.destinationIp != null)
             return false;
       } else if (!destinationIp.equals(other.destinationIp))
          return false;
       if (enabled != other.enabled)
          return false;
       if (policy == null) {
          if (other.policy != null)
             return false;
       } else if (!policy.equals(other.policy))
          return false;
       if (port != other.port)
          return false;
       if (protocols == null) {
          if (other.protocols != null)
             return false;
       } else if (!protocols.equals(other.protocols))
          return false;
       return true;
    }
 
    @Override
    public String toString() {
       return "[description=" + description + ", destinationIp=" + destinationIp + ", enabled=" + enabled + ", policy="
                + policy + ", port=" + port + ", protocols=" + protocols + "]";
    }
 
 }