siren

Class Action

java.lang.Object

siren.Action

public class Action
extends java.lang.Object

Represents an available behavior an entity exposes.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Action.Builder Constructs an instance of Action.Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines if the instance of Object provided is equal to the calling Action instance.
java.util.List<Field>	getFields() Retrieves the fields associated with the action.
java.net.URI	getHref() Retrieves the href of the action.
java.util.List<java.lang.String>	getKlass() Retrieves the class for the action.
HttpMethod	getMethod() Retrieves the method of the action.
java.lang.String	getName() Retrieves the name of the action.
java.lang.String	getTitle() Retrieves the title of the action.
java.lang.String	getType() Retrieves the type of the action.
int	hashCode() Generates hashcode represented as an integer for the calling Action instance.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Determines if the instance of Object provided is equal to the calling Action instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The instance of Action being examined.

Returns:

true if the instances are equal; false otherwise.

hashCode

public int hashCode()

Generates hashcode represented as an integer for the calling Action instance.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode for the calling Action instance.

getKlass

public java.util.List<java.lang.String> getKlass()

Retrieves the class for the action. The class describes the nature of an action based on the current representation. Possible values are implementation-dependent and should be documented.

Returns:

The class of the action.

getName

public java.lang.String getName()

Retrieves the name of the action. The name identifies the action to be performed.

Returns:

The name of the action.

getTitle

public java.lang.String getTitle()

Retrieves the title of the action. The title is descriptive text about the action.

Returns:

The title of the action.

getMethod

public HttpMethod getMethod()

Retrieves the method of the action. The method is an enumerated attribute mapping to a protocol method.

Returns:

The method of the action.

getHref

public java.net.URI getHref()

Retrieves the href of the action. The href is the URI of the action.

Returns:

The href of the action.

getType

public java.lang.String getType()

Retrieves the type of the action. The type is the encoding type for the request.

Returns:

The type of the action.

getFields

public java.util.List<Field> getFields()

Retrieves the fields associated with the action.

Returns:

The fields associated with the action.