Package uk.ac.warwick.dcs.sherlock.api.util

Enum Side

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Side>
    public enum Side
extends java.lang.Enum<Side>
    Sherlock running on a local client, a server. Use UNKNOWN when it does not matter which side

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean valid​(Side sideToCompare)  
      static Side valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Side[] 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

      • UNKNOWN

        public static final Side UNKNOWN

      • CLIENT

        public static final Side CLIENT

      • SERVER

        public static final Side SERVER

    • Method Detail

      • values

        public static Side[] 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 (Side c : Side.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Side 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

      • valid

        public boolean valid​(Side sideToCompare)