PropertyType

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.epiphan.vga2usb
Class PropertyType

    Object
      com.epiphan.vga2usb.Enum
          com.epiphan.vga2usb.Enum.Int
              com.epiphan.vga2usb.PropertyType

All Implemented Interfaces:
  Comparable

public final class PropertyType
extends com.epiphan.vga2usb.Enum.Int

Typesafe enumeration of the property types.

Field Summary
`static PropertyType` | `ADJUST_RANGE` Adjust range property.
`static PropertyType` | `BINARY` Binary property.
`static PropertyType` | `BOOL` Boolean property.
`static PropertyType` | `EDID` EDID property.
`static PropertyType` | `ENUM` Alias to INT32.
`static PropertyType` | `INT` Alias to INT32.
`static PropertyType` | `INT16` Signed short property.
`static PropertyType` | `INT32` Signed int property.
`static PropertyType` | `INT8` Signed byte property.
`static PropertyType` | `RECT` Rectangle property.
`static PropertyType` | `SIZE` Size property.
`static PropertyType` | `STRING` String property.
`static PropertyType` | `VERSION` Version property.
`static PropertyType` | `VGA_MODE` VGA mode property.

Method Summary
`int` | `compareTo(int key)` Compares id of this object with the specified key for order.
`int` | `compareTo(Object obj)` Compares this object with the specified object for order.
`String` | `getDescription()` Returns the description of this object.
`int` | `getValue()` Gets the integer value associated with this object.
`int` | `hashCode()` Returns the hashcode for this object.
`protected static int` | `search(java.util.List list, int key)` Searches the list for the specified enum object using the binary search algorithm.
`String` | `toString()` Returns a string representation of this object.

Methods inherited from class Object
`clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### ADJUST_RANGE

    public static final PropertyType ADJUST_RANGE

  Adjust range property.

  Since:
    3.22.2

### BINARY

    public static final PropertyType BINARY

  Binary property.

  Since:
    3.22.2

### BOOL

    public static final PropertyType BOOL

  Boolean property.

### EDID

    public static final PropertyType EDID

  EDID property.

### ENUM

    public static final PropertyType ENUM

  Alias to INT32.

  Since:
    3.27.1

### INT

    public static final PropertyType INT

  Alias to INT32.

### INT16

    public static final PropertyType INT16

  Signed short property.

  Since:
    3.22.2

### INT32

    public static final PropertyType INT32

  Signed int property.

  Since:
    3.22.2

### INT8

    public static final PropertyType INT8

  Signed byte property.

  Since:
    3.22.2

### RECT

    public static final PropertyType RECT

  Rectangle property.

  Since:
    3.22.2

### SIZE

    public static final PropertyType SIZE

  Size property.

  Since:
    3.22.2

### STRING

    public static final PropertyType STRING

  String property.

  Since:
    3.22.2

### VERSION

    public static final PropertyType VERSION

  Version property.

  Since:
    3.22.2

### VGA_MODE

    public static final PropertyType VGA_MODE

  VGA mode property.

  Since:
    3.22.2

Method Detail

### compareTo

    public int compareTo(int key)

  Compares id of this object with the specified key for order. Returns a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.

  Parameters:
    `key` - the key to be compared.
  Returns:
    a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### compareTo

    public int compareTo(Object obj)

  Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

  Specified by:
    `compareTo` in interface `Comparable`
  Parameters:
    `obj` - the Object to be compared.
  Returns:
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### getValue

    public final int getValue()

  Gets the integer value associated with this object.

  Returns:
    The integer value that identifies this object

### hashCode

    public final int hashCode()

  Returns the hashcode for this object.

  Returns:
    The hashcode for this object.

### search

    protected static int search(java.util.List list,
                                int key)

  Searches the list for the specified enum object using the binary search algorithm. The list must be sorted.

  Parameters:
    `list` - the list to search
    `key` - the key to search for
  Returns:
    index of the enum object, if it is contained in the list; otherwise, `(-(insertion point) - 1)`.

### getDescription

    public final String getDescription()

  Returns the description of this object.

  Returns:
    The description of this object.

### toString

    public final String toString()

  Returns a string representation of this object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`.

  Returns:
    A string representation of this object.

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2012 Epiphan Systems Inc. All rights reserved.