org.thales.punch.platform.api

Interface ITopology

All Superinterfaces:

ISettingsMap, Map<String,Object>

public interface ITopology
extends ISettingsMap

The ITopology interface lets you access a given topology resources.

Author:

dimi

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
IEntity	getChannel()
String	getName()
String	getTopologyName()

Methods inherited from interface org.thales.punch.settings.api.ISettingsMap

asFlatValuesMap, asFlatValuesMap, asFlatValuesMapIgnoreSettingsList, asHjsonString, asJsonString, asJsonString, asKvString, asListFlatValuesMapIgnoreSettingsList, asYamlString, childAsJson, childAsListOfString, childAsMapEntries, childAsMapValues, childAsRawContent, childAsRequiredListOfString, childAsRequiredString, childAsString, childAsStringContent, childAsTarGz, childFileAsMap, childIsDir, childIsFile, getAsBoolean, getAsBoolean, getAsDouble, getAsInteger, getAsInteger, getAsIsoDateTime, getAsLong, getAsLong, getAsMsDuration, getAsRequiredBoolean, getAsRequiredDouble, getAsRequiredInteger, getAsRequiredIsoDateTime, getAsRequiredLong, getAsRequiredObject, getAsRequiredObjectOfClass, getAsRequiredSettingsList, getAsRequiredSettingsMap, getAsRequiredString, getAsRequiredTimeValue, getAsRequiredZonedDateTime, getAsSettingsList, getAsSettingsList, getAsSettingsListOrEmpty, getAsSettingsMap, getAsSettingsMap, getAsString, getAsString, getAsTimeValue, getCreateAsListOfMap, getCreateMap, getDeepCopy, getMapOrEmpty, getNestedProperty, getOrCreateNestedSettingsMap, getOriginatorName, getRequiredNestedProperty, getStringOrFail, getStringOrFail, getTimeValueMs, overrideWith, putUsingDottedPath, putUsingSlashPath, removeUsingDottedPath, removeUsingSlashPath, setNestedProperty, setOriginatorName, setPropertyIfMissing

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getName

String getName()

Returns:

the name of this topology file

getTopologyName

String getTopologyName()

Returns:

the name of this topology. This is either the "name" property inside the topology json file, or the name of the file without the '.json' suffix.

getChannel

IEntity getChannel()

Returns:

this topology's channel