com.powsybl.commons.extensions

Interface Extendable<O>

All Known Subinterfaces:

Battery, Branch<I>, Bus, BusbarSection, ComputationParameters, Connectable<I>, Container<I>, DanglingLine, Generator, HvdcConverterStation<T>, HvdcLine, Identifiable<I>, Injection<I>, LccConverterStation, Line, Load, Network, ShuntCompensator, StaticVarCompensator, Substation, Switch, ThreeWindingsTransformer, TieLine, TwoWindingsTransformer, VoltageLevel, VscConverterStation

All Known Implementing Classes:

AbstractExtendable, BatteryImpl, ComputationParametersImpl, Contingency, LimitViolation, LoadFlowParameters, NetworkMetadata, SecurityAnalysisParameters, SecurityAnalysisResult, SensitivityComputationParameters

public interface Extendable<O>

Method Summary

Modifier and Type	Method and Description
<E extends Extension<O>> void	addExtension(java.lang.Class<? super E> type, E extension) Add en extension to this extendable object.
<E extends Extension<O>> E	getExtension(java.lang.Class<? super E> type) Get an extension based on its class type.
<E extends Extension<O>> E	getExtensionByName(java.lang.String name) Get an extension based on its name.
<E extends Extension<O>> java.util.Collection<E>	getExtensions() Get all extensions associated with this extendable object..
<E extends Extension<O>> boolean	removeExtension(java.lang.Class<E> type) Remove an extension based on its class type.

Method Detail

addExtension

<E extends Extension<O>> void addExtension(java.lang.Class<? super E> type,
                                           E extension)

Add en extension to this extendable object.

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

extension - the extension

getExtension

<E extends Extension<O>> E getExtension(java.lang.Class<? super E> type)

Get an extension based on its class type.

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

Returns:

the extension mapped to the class type or null if not found

getExtensionByName

<E extends Extension<O>> E getExtensionByName(java.lang.String name)

Get an extension based on its name.

Parameters:

name - the extension name

Returns:

the extension mapped to the name or null if not found

removeExtension

<E extends Extension<O>> boolean removeExtension(java.lang.Class<E> type)

Remove an extension based on its class type.

Type Parameters:

E - the extension type

Parameters:

type - the extension class type

Returns:

true if the extension has been removed false if extension has not been found

getExtensions

<E extends Extension<O>> java.util.Collection<E> getExtensions()

Get all extensions associated with this extendable object..

Returns:

all extensions associated to this extendable object.