Package org.apache.hadoop.yarn.api.records

Class ResourceTypeInfo

java.lang.Object

org.apache.hadoop.yarn.api.records.ResourceTypeInfo

All Implemented Interfaces:

java.lang.Comparable<ResourceTypeInfo>

public abstract class ResourceTypeInfo
extends java.lang.Object
implements java.lang.Comparable<ResourceTypeInfo>

Class to encapsulate information about a ResourceType - the name of the resource, the units(milli, micro, etc), the type(countable).

Constructor Summary

Constructors

Constructor	Description
ResourceTypeInfo()

Method Summary

Modifier and Type	Method	Description
int	compareTo(ResourceTypeInfo other)
static void	copy(ResourceTypeInfo src, ResourceTypeInfo dst)	Copies the content of the source ResourceTypeInfo object to the destination object, overwriting all properties of the destination object.
boolean	equals(java.lang.Object obj)
abstract java.lang.String	getDefaultUnit()	Get units for the resource.
abstract java.lang.String	getName()	Get the name for the resource.
abstract ResourceTypes	getResourceType()	Get the resource type.
int	hashCode()
static ResourceTypeInfo	newInstance(java.lang.String name)	Create a new instance of ResourceTypeInfo from name.
static ResourceTypeInfo	newInstance(java.lang.String name, java.lang.String units)	Create a new instance of ResourceTypeInfo from name, units.
static ResourceTypeInfo	newInstance(java.lang.String name, java.lang.String units, ResourceTypes type)	Create a new instance of ResourceTypeInfo from name, units and type.
static ResourceTypeInfo	newInstance(ResourceTypeInfo other)	Create a new instance of ResourceTypeInfo from another object.
abstract void	setDefaultUnit(java.lang.String rUnits)	Set the units for the resource.
abstract void	setName(java.lang.String rName)	Set the name for the resource.
abstract void	setResourceType(ResourceTypes type)	Set the resource type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTypeInfo

public ResourceTypeInfo()

Method Detail

getName

public abstract java.lang.String getName()

Get the name for the resource.

Returns:

resource name

setName

public abstract void setName(java.lang.String rName)

Set the name for the resource.

Parameters:

rName - name for the resource

getDefaultUnit

public abstract java.lang.String getDefaultUnit()

Get units for the resource.

Returns:

units for the resource

setDefaultUnit

public abstract void setDefaultUnit(java.lang.String rUnits)

Set the units for the resource.

Parameters:

rUnits - units for the resource

getResourceType

public abstract ResourceTypes getResourceType()

Get the resource type.

Returns:

the resource type

setResourceType

public abstract void setResourceType(ResourceTypes type)

Set the resource type.

Parameters:

type - the resource type

newInstance

@Public
@Unstable
public static ResourceTypeInfo newInstance(ResourceTypeInfo other)

Create a new instance of ResourceTypeInfo from another object.

Parameters:

other - the object from which the new object should be created

Returns:

the new ResourceTypeInfo object

newInstance

@Public
@Unstable
public static ResourceTypeInfo newInstance(java.lang.String name,
                                           java.lang.String units,
                                           ResourceTypes type)

Create a new instance of ResourceTypeInfo from name, units and type.

Parameters:

name - name of resource type

units - units of resource type

type - such as countable, etc.

Returns:

the new ResourceTypeInfo object

newInstance

@Public
@Unstable
public static ResourceTypeInfo newInstance(java.lang.String name,
                                           java.lang.String units)

Create a new instance of ResourceTypeInfo from name, units.

Parameters:

name - name of resource type

units - units of resource type

Returns:

the new ResourceTypeInfo object

newInstance

@Public
@Unstable
public static ResourceTypeInfo newInstance(java.lang.String name)

Create a new instance of ResourceTypeInfo from name.

Parameters:

name - name of resource type

Returns:

the new ResourceTypeInfo object

copy

public static void copy(ResourceTypeInfo src,
                        ResourceTypeInfo dst)

Copies the content of the source ResourceTypeInfo object to the destination object, overwriting all properties of the destination object.

Parameters:

src - Source ResourceTypeInfo object

dst - Destination ResourceTypeInfo object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ResourceTypeInfo other)

Specified by:

compareTo in interface java.lang.Comparable<ResourceTypeInfo>