Class AbstractBreakable

java.lang.Object

org.soliscode.test.OptionalMethodSupport

org.soliscode.test.breakable.AbstractBreakable

All Implemented Interfaces:

Breakable, SupportedMethods

Direct Known Subclasses:

BreakableIterable, BreakableIterator, BreakableSpliterator

public abstract class AbstractBreakable
extends OptionalMethodSupport
implements Breakable

Utility class for implementing the Breakable interface.

Since:

1.0

Author:

evanbergstrom

Constructor Summary

Constructors

Constructor	Description
AbstractBreakable()	Create a breakable object with no breaks.
AbstractBreakable(@NotNull Collection<Break> breaks)	Create a breakable object with a specified set of breaks.
AbstractBreakable(@NotNull AbstractBreakable other)	Create a breakable object with the same breaks as another breakable object.

Method Summary

Modifier and Type	Method	Description
void	addBreaks(@NotNull Collection<Break> breaks)	Adds a set of breaks to this object.
@NotNull Set<Break>	breaks()	Returns all of the breaks that have been added to this object.
boolean	hasBreak(@NotNull Break aBreak)	Determines if this instance has a specified break.

Methods inherited from class org.soliscode.test.OptionalMethodSupport

doesNotSupportMethod, supportsMethod, unsupportedMethods

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBreakable

public AbstractBreakable()

Create a breakable object with no breaks.

AbstractBreakable

public AbstractBreakable(@NotNull
 @NotNull AbstractBreakable other)

Create a breakable object with the same breaks as another breakable object.

Parameters:

other - the breakable object to copy.

AbstractBreakable

public AbstractBreakable(@NotNull
 @NotNull Collection<Break> breaks)

Create a breakable object with a specified set of breaks.

Parameters:

breaks - the set of breaks for the object.

Method Details

hasBreak

public boolean hasBreak(@NotNull
 @NotNull Break aBreak)

Description copied from interface: Breakable

Determines if this instance has a specified break. The default value for all breaks that have not been added is false.

Specified by:

hasBreak in interface Breakable

Parameters:

aBreak - The break to determine if ti has been added to this instance.

Returns:

'true' if the break has been added, 'false' if it has not.

breaks

@NotNull
public @NotNull Set<Break> breaks()

Description copied from interface: Breakable

Returns all of the breaks that have been added to this object.

Specified by:

breaks in interface Breakable

Returns:

The set of breaks that have ben added.

addBreaks

public void addBreaks(@NotNull
 @NotNull Collection<Break> breaks)

Description copied from interface: Breakable

Adds a set of breaks to this object.

Specified by:

addBreaks in interface Breakable

Parameters:

breaks - the breaks to add.