org.xwiki.refactoring.job.question

Class EntitySelection

java.lang.Object

org.xwiki.refactoring.job.question.EntitySelection

All Implemented Interfaces:

Comparable<EntitySelection>

public class EntitySelection
extends Object
implements Comparable<EntitySelection>

Represent an entity with an information about either or not the entity is selected to perform some refactoring.

Since:

9.1RC1

Version:

$Id: 24ee96ac07519e3bc1eb318ecaeb84878ec6a9cb $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntitySelection.State Define the inner state of the EntitySelection.

Constructor Summary

Constructors

Constructor and Description
EntitySelection(org.xwiki.model.reference.EntityReference entityReference) Construct an EntitySelection.

Method Summary

Modifier and Type	Method and Description
int	compareTo(EntitySelection entitySelection)
boolean	equals(Object object)
org.xwiki.model.reference.EntityReference	getEntityReference()
EntitySelection.State	getState()
int	hashCode()
boolean	isSelected()
void	setSelected(boolean selected) Change the state of the entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitySelection

public EntitySelection(org.xwiki.model.reference.EntityReference entityReference)

Construct an EntitySelection.

Parameters:

entityReference - the reference of the entity concerned by the refactoring

Method Detail

getEntityReference

public org.xwiki.model.reference.EntityReference getEntityReference()

Returns:

the reference of the entity to select

isSelected

public boolean isSelected()

Returns:

true if the user has selected the entity or no choice has been made

getState

public EntitySelection.State getState()

Returns:

current state of the entity selection.

setSelected

public void setSelected(boolean selected)

Change the state of the entity.

Parameters:

selected - either or not the user has selected the entity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

compareTo

public int compareTo(EntitySelection entitySelection)

Specified by:

compareTo in interface Comparable<EntitySelection>