public class SwitchAdapter extends Object implements Switch
Modifier and Type | Method and Description |
---|---|
void |
addAlias(String alias)
Add an alias to the object.
|
void |
addAlias(String alias,
String aliasType)
Add an alias to the object.
|
<E extends Extension<I>> |
addExtension(Class<? super E> type,
E extension)
Add en extension to this extendable object.
|
Set<String> |
getAliases()
Get the aliases of the object.
|
Optional<String> |
getAliasFromType(String aliasType)
Get the alias of the object with a given alias type if it exists.
|
Optional<String> |
getAliasType(String alias)
Get the alias type of an alias if it exists, an empty optional otherwise.
|
protected I |
getDelegate() |
<E extends Extension<I>> |
getExtension(Class<? super E> type)
Get an extension based on its class type.
|
<E extends Extension<I>> |
getExtensionByName(String name)
Get an extension based on its name.
|
<E extends Extension<I>> |
getExtensions()
Get all extensions associated with this extendable object..
|
String |
getId()
Get the unique identifier of the object.
|
String |
getImplementationName()
Returns a name that is used to find matching
ExtensionAdderProvider s
when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>) . |
protected com.powsybl.iidm.mergingview.MergingViewIndex |
getIndex() |
SwitchKind |
getKind()
Get the kind of switch.
|
String |
getNameOrId()
Get the name of the object if it exists.
|
MergingView |
getNetwork()
Get the network associated to the object.
|
Optional<String> |
getOptionalName()
Return an optional containing the name of the object if it exists.
|
String |
getProperty(String key)
Get property associated to specified key.
|
String |
getProperty(String key,
String defaultValue)
Get property associated to specified key, with default value.
|
Set<String> |
getPropertyNames()
Get properties key values.
|
VoltageLevelAdapter |
getVoltageLevel()
Get the parent voltage level.
|
boolean |
hasAliases()
Return true if identifiable has aliases.
|
boolean |
hasProperty()
Check that this object has some properties.
|
boolean |
hasProperty(String key)
Check that this object has property with specified name.
|
boolean |
isFictitious()
Get the fictitious status
|
boolean |
isOpen()
Get the open status of the switch.
|
boolean |
isRetained()
Get the retain status of the switch.
|
<E extends Extension<I>,B extends ExtensionAdder<I,E>> |
newExtension(Class<B> type)
Returns an extensionAdder to build and add an extension for this extendable.
|
void |
removeAlias(String alias)
Remove an alias of the object.
|
<E extends Extension<I>> |
removeExtension(Class<E> type)
Remove an extension based on its class type.
|
void |
setFictitious(boolean fictitious)
Set the fictitious status
|
void |
setOpen(boolean open)
Change the switch status.
|
String |
setProperty(String key,
String value)
Set property value associated to specified key.
|
void |
setRetained(boolean retained)
Change the retain status of the switch.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, setFictitious, setProperty
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
public VoltageLevelAdapter getVoltageLevel()
Switch
getVoltageLevel
in interface Switch
public SwitchKind getKind()
Switch
public boolean isOpen()
Switch
Depends on the working variant.
isOpen
in interface Switch
VariantManager
public void setOpen(boolean open)
Switch
Depends on the working variant.
setOpen
in interface Switch
open
- the new switch statusVariantManager
public boolean isRetained()
Switch
isRetained
in interface Switch
public void setRetained(boolean retained)
Switch
setRetained
in interface Switch
retained
- the retain status of the switchpublic MergingView getNetwork()
Identifiable
getNetwork
in interface Identifiable<I extends Identifiable<I>>
public String getId()
Identifiable
getId
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getOptionalName()
Identifiable
getOptionalName
in interface Identifiable<I extends Identifiable<I>>
public String getNameOrId()
Identifiable
getNameOrId
in interface Identifiable<I extends Identifiable<I>>
public boolean hasProperty()
Identifiable
hasProperty
in interface Identifiable<I extends Identifiable<I>>
public boolean hasProperty(String key)
Identifiable
hasProperty
in interface Identifiable<I extends Identifiable<I>>
public String getProperty(String key)
Identifiable
getProperty
in interface Identifiable<I extends Identifiable<I>>
public String getProperty(String key, String defaultValue)
Identifiable
getProperty
in interface Identifiable<I extends Identifiable<I>>
public String setProperty(String key, String value)
Identifiable
setProperty
in interface Identifiable<I extends Identifiable<I>>
public Set<String> getPropertyNames()
Identifiable
getPropertyNames
in interface Identifiable<I extends Identifiable<I>>
public boolean isFictitious()
Identifiable
isFictitious
in interface Identifiable<I extends Identifiable<I>>
public void setFictitious(boolean fictitious)
Identifiable
setFictitious
in interface Identifiable<I extends Identifiable<I>>
public <E extends Extension<I>> void addExtension(Class<? super E> type, E extension)
Extendable
addExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typeextension
- the extensionpublic <E extends Extension<I>> E getExtension(Class<? super E> type)
Extendable
getExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typepublic <E extends Extension<I>> E getExtensionByName(String name)
Extendable
getExtensionByName
in interface Extendable<I extends Identifiable<I>>
name
- the extension namepublic <E extends Extension<I>> boolean removeExtension(Class<E> type)
Extendable
removeExtension
in interface Extendable<I extends Identifiable<I>>
E
- the extension typetype
- the extension class typepublic <E extends Extension<I>> Collection<E> getExtensions()
Extendable
getExtensions
in interface Extendable<I extends Identifiable<I>>
public String getImplementationName()
Extendable
ExtensionAdderProvider
s
when selecting implementations of extensions in Extendable.newExtension(java.lang.Class<B>)
. This
is meant to be overriden by extendables when multiple implementations exist.getImplementationName
in interface Extendable<I extends Identifiable<I>>
public <E extends Extension<I>,B extends ExtensionAdder<I,E>> B newExtension(Class<B> type)
Extendable
The extension implementation is selected at runtime based on matching the
Extendable.getImplementationName()
of this extendable to the
ExtensionAdderProvider.getImplementationName()
of a provider.
Implementations are loaded with java's ServiceLoader
using
the ExtensionAdderProvider interface.
newExtension
in interface Extendable<I extends Identifiable<I>>
type
- The interface of the ExtensionAdderpublic Set<String> getAliases()
Identifiable
getAliases
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getAliasFromType(String aliasType)
Identifiable
getAliasFromType
in interface Identifiable<I extends Identifiable<I>>
public Optional<String> getAliasType(String alias)
Identifiable
getAliasType
in interface Identifiable<I extends Identifiable<I>>
public void addAlias(String alias)
Identifiable
PowsyblException
addAlias
in interface Identifiable<I extends Identifiable<I>>
public void addAlias(String alias, String aliasType)
Identifiable
PowsyblException
If a given non null type already has an associated alias for this object, throw a PowsyblException
addAlias
in interface Identifiable<I extends Identifiable<I>>
public void removeAlias(String alias)
Identifiable
PowsyblException
removeAlias
in interface Identifiable<I extends Identifiable<I>>
public boolean hasAliases()
Identifiable
hasAliases
in interface Identifiable<I extends Identifiable<I>>
protected I getDelegate()
protected com.powsybl.iidm.mergingview.MergingViewIndex getIndex()
Copyright © 2020. All rights reserved.