/*
    * Copyright 2013 The Netty Project
    *
    * The Netty Project 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:
    *
    *   https://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 io.netty.handler.codec.socksx.v5;
  
  import io.netty.util.internal.ObjectUtil;
  
  /**
   * The authentication method of SOCKS5.
   */
  public class Socks5AuthMethod implements Comparable<Socks5AuthMethod> {
  
      public static final Socks5AuthMethod NO_AUTH = new Socks5AuthMethod(0x00, "NO_AUTH");
      public static final Socks5AuthMethod GSSAPI = new Socks5AuthMethod(0x01, "GSSAPI");
      public static final Socks5AuthMethod PASSWORD = new Socks5AuthMethod(0x02, "PASSWORD");
  
      /**
       * Indicates that the server does not accept any authentication methods the client proposed.
       */
      public static final Socks5AuthMethod UNACCEPTED = new Socks5AuthMethod(0xff, "UNACCEPTED");
  
      /**
       * Returns whether the authentication method code is in the private methods range (0x80-0xFE)
       * as defined by <a href="https://www.ietf.org/rfc/rfc1928.txt">RFC 1928 section 3</a>.
       *
       * @param b The authentication method code
       * @return true if the code is in the private methods range
       */
      public static boolean isPrivateMethod(byte b) {
          int ubyte = b & 0xFF;
          return ubyte >= 0x80 && ubyte <= 0xFE;
      }
  
      public static Socks5AuthMethod valueOf(byte b) {
          switch (b) {
          case 0x00:
              return NO_AUTH;
          case 0x01:
              return GSSAPI;
          case 0x02:
              return PASSWORD;
          case (byte) 0xFF:
              return UNACCEPTED;
          }
  
          // Handle all private methods (0x80-0xFE)
          if (isPrivateMethod(b)) {
              return new Socks5AuthMethod(b, "PRIVATE_" + (b & 0xFF));
          }
  
          return new Socks5AuthMethod(b);
      }
  
      private final byte byteValue;
      private final String name;
      private String text;
  
      public Socks5AuthMethod(int byteValue) {
          this(byteValue, "UNKNOWN");
      }
  
      public Socks5AuthMethod(int byteValue, String name) {
          this.name = ObjectUtil.checkNotNull(name, "name");
          this.byteValue = (byte) byteValue;
      }
  
      public byte byteValue() {
          return byteValue;
      }
  
      @Override
      public int hashCode() {
          return byteValue;
      }
  
      @Override
      public boolean equals(Object obj) {
          if (!(obj instanceof Socks5AuthMethod)) {
              return false;
          }
  
          return byteValue == ((Socks5AuthMethod) obj).byteValue;
      }
  
      @Override
      public int compareTo(Socks5AuthMethod o) {
         return byteValue - o.byteValue;
     }
 
     @Override
     public String toString() {
         String text = this.text;
         if (text == null) {
             this.text = text = name + '(' + (byteValue & 0xFF) + ')';
         }
         return text;
     }
 }