net.caseif.flint.challenger

Interface Team

All Superinterfaces:

Component<Round>, MetadataHolder

public interface Team
extends MetadataHolder, Component<Round>

Represents a team containing Challengers in a Round.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	addChallenger(Challenger challenger) Adds the given Challenger to this Team and implicitly removing it from its current Team if applicable.
ImmutableList<Challenger>	getChallengers() Returns an ImmutableList of all Challengers on this Team.
String	getId() Gets the internal identifier of this Team.
String	getName() Gets the display name of this Team.
Round	getRound() Gets the Round this Team is owned by.
void	removeChallenger(Challenger challenger) Removes the given Challenger from this Team.
void	setName(String name) Sets the display name of this Team.

Methods inherited from interface net.caseif.flint.metadata.MetadataHolder

getMetadata

Methods inherited from interface net.caseif.flint.component.Component

getOwner

Method Detail

getRound

Round getRound()
        throws OrphanedComponentException

Gets the Round this Team is owned by.

Note: This a convenience method for Component.getOwner().

Returns:

The Round this Team is owned by

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getId

String getId()
      throws OrphanedComponentException

Gets the internal identifier of this Team.

Returns:

The internal identifier of this Team

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getName

String getName()
        throws OrphanedComponentException

Gets the display name of this Team.

Returns:

The display name of this Team

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setName

void setName(String name)
      throws OrphanedComponentException

Sets the display name of this Team.

Parameters:

name - The new display name of this Team

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getChallengers

ImmutableList<Challenger> getChallengers()
                                  throws OrphanedComponentException

Returns an ImmutableList of all Challengers on this Team.

Returns:

An ImmutableList of all Challengers on this Team

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

addChallenger

void addChallenger(Challenger challenger)
            throws IllegalArgumentException,
                   OrphanedComponentException

Adds the given Challenger to this Team and implicitly removing it from its current Team if applicable.

Parameters:

challenger - The Challenger to add

Throws:

IllegalArgumentException - If the givene Challenger is owned by a different Round than the one parenting this Team

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

removeChallenger

void removeChallenger(Challenger challenger)
               throws IllegalArgumentException,
                      OrphanedComponentException

Removes the given Challenger from this Team. This implicitly removes it from its current Team if applicable.

Parameters:

challenger - The Challenger to remove

Throws:

IllegalArgumentException - If the given Challenger is not on this Team

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0