com.ur.urcap.api.domain.program.nodes.contributable

Interface URCapProgramNode

All Superinterfaces:

ProgramNode

public interface URCapProgramNode
extends ProgramNode

This interface is a representation of an instance of a ProgramNodeContribution.

Method Summary

Modifier and Type	Method and Description
boolean	canGetAs(Class<?> urCapProgramNodeInterface) This method returns true if a subsequent call to getAs(Class) using the same parameter will be successful.
<T> T	getAs(Class<T> urCapProgramNodeInterface) The URCap program node contribution (i.e.

Method Detail

canGetAs

boolean canGetAs(Class<?> urCapProgramNodeInterface)

This method returns true if a subsequent call to getAs(Class) using the same parameter will be successful.

Parameters:

urCapProgramNodeInterface - the interface the program node implements, not null.

Returns:

true if the program node can be represented as the specified interface. false otherwise.

getAs

<T> T getAs(Class<T> urCapProgramNodeInterface)

The URCap program node contribution (i.e. the class implementing ProgramNodeContribution) can optionally implement additional interfaces providing access to various information and/or methods. If such an interface is implemented, the getAs(Class) method can be used to retrieve the program node as said interface. Do not use ProgramNodeContribution (or an extension/implementation thereof) nor Object as argument, otherwise an IllegalArgumentException is thrown.

Type Parameters:

T - The (generic) type parameter for the interface.

Parameters:

urCapProgramNodeInterface - the interface the program node implements, not null.

Returns:

the program node represented as the interface specified. If the program node has not been added to the program tree, null will be returned.

Throws:

ClassCastException - If the program node does not implement the interface a class cast exception will be thrown.

IllegalArgumentException - If the type parameter is an implementation/extension of ProgramNodeContribution or Object.