io.nats.client

Enum NKey.Type

java.lang.Object

java.lang.Enum<NKey.Type>

io.nats.client.NKey.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NKey.Type>

Enclosing class:

NKey

public static enum NKey.Type
extends java.lang.Enum<NKey.Type>

NKeys use a prefix byte to indicate their intended owner: 'N' = server, 'C' = cluster, 'A' = account, and 'U' = user. 'P' is used for private keys. The NKey class formalizes these into the enum NKey.Type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCOUNT An account NKey.
CLUSTER A cluster NKey.
OPERATOR An operator NKey.
PRIVATE A private NKey.
SERVER A server NKey.
USER A user NKey.

Method Summary

Modifier and Type	Method and Description
static NKey.Type	fromPrefix(int prefix)
static NKey.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NKey.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USER

public static final NKey.Type USER

A user NKey.

ACCOUNT

public static final NKey.Type ACCOUNT

An account NKey.

SERVER

public static final NKey.Type SERVER

A server NKey.

OPERATOR

public static final NKey.Type OPERATOR

An operator NKey.

CLUSTER

public static final NKey.Type CLUSTER

A cluster NKey.

PRIVATE

public static final NKey.Type PRIVATE

A private NKey.

Method Detail

values

public static NKey.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NKey.Type c : NKey.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NKey.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromPrefix

public static NKey.Type fromPrefix(int prefix)