Package org.apache.hadoop.io

Class EnumSetWritable<E extends java.lang.Enum<E>>

java.lang.Object

java.util.AbstractCollection<E>

org.apache.hadoop.io.EnumSetWritable<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, Configurable, Writable

@Public
@Stable
public class EnumSetWritable<E extends java.lang.Enum<E>>
extends java.util.AbstractCollection<E>
implements Writable, Configurable

A Writable wrapper for EnumSet.

Constructor Summary

Constructors

Constructor	Description
EnumSetWritable(java.util.EnumSet<E> value)	Construct a new EnumSetWritable.
EnumSetWritable(java.util.EnumSet<E> value, java.lang.Class<E> elementType)	Construct a new EnumSetWritable.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	equals(java.lang.Object o)	Returns true if o is an EnumSetWritable with the same value, or both are null.
java.util.EnumSet<E>	get()	Return the value of this EnumSetWritable.
Configuration	getConf()	Return the configuration used by this object.
java.lang.Class<E>	getElementType()	Returns the class of all the elements of the underlying EnumSetWriable.
int	hashCode()
java.util.Iterator<E>	iterator()
void	readFields(java.io.DataInput in)	Deserialize the fields of this object from in.
void	set(java.util.EnumSet<E> value, java.lang.Class<E> elementType)	reset the EnumSetWritable with specified value and elementType.
void	setConf(Configuration conf)	Set the configuration to be used by this object.
int	size()
java.lang.String	toString()
void	write(java.io.DataOutput out)	Serialize the fields of this object to out.

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

EnumSetWritable

public EnumSetWritable(java.util.EnumSet<E> value,
                       java.lang.Class<E> elementType)

Construct a new EnumSetWritable. If the value argument is null or its size is zero, the elementType argument must not be null. If the argument value's size is bigger than zero, the argument elementType is not be used.

Parameters:

value - enumSet value.

elementType - elementType.

EnumSetWritable

public EnumSetWritable(java.util.EnumSet<E> value)

Construct a new EnumSetWritable. Argument value should not be null or empty.

Parameters:

value - enumSet value.

Method Detail

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.util.Collection<E extends java.lang.Enum<E>>

Specified by:

iterator in interface java.lang.Iterable<E extends java.lang.Enum<E>>

Specified by:

iterator in class java.util.AbstractCollection<E extends java.lang.Enum<E>>

size

public int size()

Specified by:

size in interface java.util.Collection<E extends java.lang.Enum<E>>

Specified by:

size in class java.util.AbstractCollection<E extends java.lang.Enum<E>>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E extends java.lang.Enum<E>>

Overrides:

add in class java.util.AbstractCollection<E extends java.lang.Enum<E>>

set

public void set(java.util.EnumSet<E> value,
                java.lang.Class<E> elementType)

reset the EnumSetWritable with specified value and elementType. If the value argument is null or its size is zero, the elementType argument must not be null. If the argument value's size is bigger than zero, the argument elementType is not be used.

Parameters:

value - enumSet Value.

elementType - elementType.

get

public java.util.EnumSet<E> get()

Return the value of this EnumSetWritable.

Returns:

EnumSet.

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

java.io.IOException - any other problem for readFields.

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

java.io.IOException - any other problem for write.

equals

public boolean equals(java.lang.Object o)

Returns true if o is an EnumSetWritable with the same value, or both are null.

Specified by:

equals in interface java.util.Collection<E extends java.lang.Enum<E>>

Overrides:

equals in class java.lang.Object

getElementType

public java.lang.Class<E> getElementType()

Returns the class of all the elements of the underlying EnumSetWriable. It may return null.

Returns:

the element class

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E extends java.lang.Enum<E>>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<E extends java.lang.Enum<E>>

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

Returns:

Configuration

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Parameters:

conf - configuration to be used