io.opencannabis.schema.crypto.primitives.KeyDisposition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Java RPCAPI client for the Bloombox Cloud.
The newest version!
/*
 * Copyright 2019, Momentum Ideas Co.
 *
 * 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.
 */

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: crypto/primitives/Keys.proto

package io.opencannabis.schema.crypto.primitives;

/**
 *  * Specifies the known key disposition options for a given key. This indicates the use parameters for a key structure.
 * Secret keys, or private keys, should always be kept private. Ephemeral keys are private but meant for temporally
 * bounded use in some specific context or circumstance.
 * 
 *
 * Protobuf enum {@code opencannabis.crypto.KeyDisposition}
 */
public enum KeyDisposition
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   *    * Secret key for a symmetric connection, or the private portion of an asymmetric keypair.
   * 
   *
   * PRIVATE = 0;
   */
  PRIVATE(0),
  /**
   *    * Ephemeral key for a given session or specific context. Considered secret.
   * 
   *
   * EPHEMERAL = 1;
   */
  EPHEMERAL(1),
  /**
   *    * Public portion of an asymmetric keypair.
   * 
   *
   * PUBLIC = 2;
   */
  PUBLIC(2),
  UNRECOGNIZED(-1),
  ;

  /**
   *    * Secret key for a symmetric connection, or the private portion of an asymmetric keypair.
   * 
   *
   * PRIVATE = 0;
   */
  public static final int PRIVATE_VALUE = 0;
  /**
   *    * Ephemeral key for a given session or specific context. Considered secret.
   * 
   *
   * EPHEMERAL = 1;
   */
  public static final int EPHEMERAL_VALUE = 1;
  /**
   *    * Public portion of an asymmetric keypair.
   * 
   *
   * PUBLIC = 2;
   */
  public static final int PUBLIC_VALUE = 2;


  public final int getNumber() {
    if (this == UNRECOGNIZED) {
      throw new java.lang.IllegalArgumentException(
          "Can't get the number of an unknown enum value.");
    }
    return value;
  }

  /**
   * @deprecated Use {@link #forNumber(int)} instead.
   */
  @java.lang.Deprecated
  public static KeyDisposition valueOf(int value) {
    return forNumber(value);
  }

  public static KeyDisposition forNumber(int value) {
    switch (value) {
      case 0: return PRIVATE;
      case 1: return EPHEMERAL;
      case 2: return PUBLIC;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      KeyDisposition> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public KeyDisposition findValueByNumber(int number) {
            return KeyDisposition.forNumber(number);
          }
        };

  public final com.google.protobuf.Descriptors.EnumValueDescriptor
      getValueDescriptor() {
    return getDescriptor().getValues().get(ordinal());
  }
  public final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptorForType() {
    return getDescriptor();
  }
  public static final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptor() {
    return io.opencannabis.schema.crypto.primitives.Keys.getDescriptor().getEnumTypes().get(1);
  }

  private static final KeyDisposition[] VALUES = values();

  public static KeyDisposition valueOf(
      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
    if (desc.getType() != getDescriptor()) {
      throw new java.lang.IllegalArgumentException(
        "EnumValueDescriptor is not for this type.");
    }
    if (desc.getIndex() == -1) {
      return UNRECOGNIZED;
    }
    return VALUES[desc.getIndex()];
  }

  private final int value;

  private KeyDisposition(int value) {
    this.value = value;
  }

  // @@protoc_insertion_point(enum_scope:opencannabis.crypto.KeyDisposition)
}