ByteTypeOps (Apache Giraph Parent 1.4.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<ByteTypeOps>
- - org.apache.giraph.types.ops.ByteTypeOps

All Implemented Interfaces:

Serializable, Comparable<ByteTypeOps>, NumericTypeOps<org.apache.hadoop.io.ByteWritable>, PrimitiveTypeOps<org.apache.hadoop.io.ByteWritable>, TypeOps<org.apache.hadoop.io.ByteWritable>
```
public enum ByteTypeOps
extends Enum<ByteTypeOps>
implements PrimitiveTypeOps<org.apache.hadoop.io.ByteWritable>, NumericTypeOps<org.apache.hadoop.io.ByteWritable>
```
TypeOps implementation for working with ByteWritable type

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
Singleton instance

Enum Constants
Enum Constant and Description
`INSTANCE` Singleton instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(org.apache.hadoop.io.ByteWritable value1, org.apache.hadoop.io.ByteWritable value2)` Compare two values
`org.apache.hadoop.io.ByteWritable`	`create()` Create new instance of type T.
`WByteArrayList`	`createArrayList()` Create WArrayList of type T.
`WByteArrayList`	`createArrayList(int capacity)` Create WArrayList of type T, given capacity.
`org.apache.hadoop.io.ByteWritable`	`createCopy(org.apache.hadoop.io.ByteWritable from)` Create a copy of passed object
`org.apache.hadoop.io.ByteWritable`	`createMaxPositiveValue()` Maximal positive value representable via current type.
`org.apache.hadoop.io.ByteWritable`	`createMinNegativeValue()` Minimal negative value representable via current type.
`org.apache.hadoop.io.ByteWritable`	`createOne()` Value of one
`org.apache.hadoop.io.ByteWritable`	`createZero()` Value of zero
`Class<org.apache.hadoop.io.ByteWritable>`	`getTypeClass()` Class object for generic type T.
`void`	`multiplyInto(org.apache.hadoop.io.ByteWritable value, org.apache.hadoop.io.ByteWritable multiplier)` value*=multiplier
`void`	`negate(org.apache.hadoop.io.ByteWritable value)` -value
`void`	`plusInto(org.apache.hadoop.io.ByteWritable value, org.apache.hadoop.io.ByteWritable increment)` value+=adder
`WByteArrayList`	`readNewArrayList(DataInput in)` Create WArrayList of type T by reading it from given input.
`void`	`set(org.apache.hadoop.io.ByteWritable to, org.apache.hadoop.io.ByteWritable from)` Copies the value from the second argument into the first.
`static ByteTypeOps`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ByteTypeOps[]`	`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
  - INSTANCE
```
public static final ByteTypeOps INSTANCE
```
    Singleton instance
- Method Detail
  - values
```
public static ByteTypeOps[] 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 (ByteTypeOps c : ByteTypeOps.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ByteTypeOps valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getTypeClass
```
public Class<org.apache.hadoop.io.ByteWritable> getTypeClass()
```
    Description copied from interface: TypeOps
    
    Class object for generic type T.
    
    Specified by:
    
    getTypeClass in interface TypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    Class<T> object
  - create
```
public org.apache.hadoop.io.ByteWritable create()
```
    Description copied from interface: TypeOps
    
    Create new instance of type T.
    
    Specified by:
    
    create in interface TypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    new instance
  - createCopy
```
public org.apache.hadoop.io.ByteWritable createCopy(org.apache.hadoop.io.ByteWritable from)
```
    Description copied from interface: TypeOps
    
    Create a copy of passed object
    
    Specified by:
    
    createCopy in interface TypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    from - Object to copy
    
    Returns:
    
    Copy
  - set
```
public void set(org.apache.hadoop.io.ByteWritable to,
                org.apache.hadoop.io.ByteWritable from)
```
    Description copied from interface: TypeOps
    
    Copies the value from the second argument into the first.
    
    Specified by:
    
    set in interface TypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    to - Object into which the value should be copied
    
    from - Value of object to be copied
  - createArrayList
```
public WByteArrayList createArrayList()
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T.
    
    Specified by:
    
    createArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    WArrayList
  - createArrayList
```
public WByteArrayList createArrayList(int capacity)
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T, given capacity.
    
    Specified by:
    
    createArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    capacity - Capacity
    
    Returns:
    
    WArrayList
  - readNewArrayList
```
public WByteArrayList readNewArrayList(DataInput in)
                                throws IOException
```
    Description copied from interface: PrimitiveTypeOps
    
    Create WArrayList of type T by reading it from given input.
    
    Specified by:
    
    readNewArrayList in interface PrimitiveTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    in - Input
    
    Returns:
    
    WArrayList
    
    Throws:
    
    IOException
  - createZero
```
public org.apache.hadoop.io.ByteWritable createZero()
```
    Description copied from interface: NumericTypeOps
    
    Value of zero
    
    Specified by:
    
    createZero in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    New object with value of zero
  - createOne
```
public org.apache.hadoop.io.ByteWritable createOne()
```
    Description copied from interface: NumericTypeOps
    
    Value of one
    
    Specified by:
    
    createOne in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    New object with value of one
  - createMinNegativeValue
```
public org.apache.hadoop.io.ByteWritable createMinNegativeValue()
```
    Description copied from interface: NumericTypeOps
    
    Minimal negative value representable via current type. Negative infinity for floating point numbers.
    
    Specified by:
    
    createMinNegativeValue in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    New object with min negative value
  - createMaxPositiveValue
```
public org.apache.hadoop.io.ByteWritable createMaxPositiveValue()
```
    Description copied from interface: NumericTypeOps
    
    Maximal positive value representable via current type. Positive infinity for floating point numbers.
    
    Specified by:
    
    createMaxPositiveValue in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Returns:
    
    New object with max positive value
  - plusInto
```
public void plusInto(org.apache.hadoop.io.ByteWritable value,
                     org.apache.hadoop.io.ByteWritable increment)
```
    Description copied from interface: NumericTypeOps
    
    value+=adder
    
    Specified by:
    
    plusInto in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    value - Value to modify
    
    increment - Increment
  - multiplyInto
```
public void multiplyInto(org.apache.hadoop.io.ByteWritable value,
                         org.apache.hadoop.io.ByteWritable multiplier)
```
    Description copied from interface: NumericTypeOps
    
    value*=multiplier
    
    Specified by:
    
    multiplyInto in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    value - Value to modify
    
    multiplier - Multiplier
  - negate
```
public void negate(org.apache.hadoop.io.ByteWritable value)
```
    Description copied from interface: NumericTypeOps
    
    -value
    
    Specified by:
    
    negate in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    value - Value to negate
  - compare
```
public int compare(org.apache.hadoop.io.ByteWritable value1,
                   org.apache.hadoop.io.ByteWritable value2)
```
    Description copied from interface: NumericTypeOps
    
    Compare two values
    
    Specified by:
    
    compare in interface NumericTypeOps<org.apache.hadoop.io.ByteWritable>
    
    Parameters:
    
    value1 - First value
    
    value2 - Second value
    
    Returns:
    
    0 if values are equal, negative value if value1<value2 and positive value if value1>value2

Enum ByteTypeOps

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Method Detail

values

valueOf

getTypeClass

create

createCopy

set

createArrayList

createArrayList

readNewArrayList

createZero

createOne

createMinNegativeValue

createMaxPositiveValue

plusInto

multiplyInto

negate

compare