Class IconManagerImpl
- java.lang.Object
-
- com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle
-
- com.inductiveautomation.perspective.gateway.assets.AbstractAssetManager<java.lang.String,com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary>
-
- com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl
-
- All Implemented Interfaces:
IconManager
public class IconManagerImpl extends AbstractAssetManager<java.lang.String,com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary> implements IconManager
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.perspective.gateway.assets.AbstractAssetManager
assetPath, perspectiveContext
-
-
Constructor Summary
Constructors Constructor Description IconManagerImpl(PerspectiveContext perspectiveContext)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonObject>
digests()
protected java.util.Optional<java.lang.String>
generateKey(java.nio.file.Path path)
Generate a cache key for the givenPath
java.util.Optional<java.lang.String>
getLibDigest(java.lang.String libraryKey)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>
getLibraries()
Fetch a map of all icon library names and their respective icon namesjava.util.Optional<java.lang.String>
getLibrary(java.lang.String libraryName)
Fetch the raw icon library as an SVG Stringprotected java.util.Optional<com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary>
parseValue(java.nio.file.Path path)
Parse the cache value for the givenPath
-
Methods inherited from class com.inductiveautomation.perspective.gateway.assets.AbstractAssetManager
copyInputStreamToPath, copyInputStreamToPath, getCache, getCachedValue, getDigestCopy, getDigestFor, onCacheChanged, onShutdown, onStartup, setup
-
Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle
isRunning, shutdown, startup
-
-
-
-
Constructor Detail
-
IconManagerImpl
public IconManagerImpl(@Nonnull PerspectiveContext perspectiveContext)
-
-
Method Detail
-
generateKey
@Nonnull protected java.util.Optional<java.lang.String> generateKey(@Nonnull java.nio.file.Path path)
Description copied from class:AbstractAssetManager
Generate a cache key for the givenPath
- Specified by:
generateKey
in classAbstractAssetManager<java.lang.String,com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary>
- Parameters:
path
- ThePath
for which we want to generate a cache key- Returns:
- An
Optional
containing the cache key or an empty Optional if the cache key could not be generated
-
parseValue
@Nonnull protected java.util.Optional<com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary> parseValue(@Nonnull java.nio.file.Path path)
Description copied from class:AbstractAssetManager
Parse the cache value for the givenPath
- Specified by:
parseValue
in classAbstractAssetManager<java.lang.String,com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl.IconLibrary>
- Parameters:
path
- ThePath
for which we want to generate a cache value- Returns:
- An
Optional
containing the cache value or an empty Optional if the cache value could not be generated
-
getLibraries
@Nonnull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getLibraries()
Description copied from interface:IconManager
Fetch a map of all icon library names and their respective icon names- Specified by:
getLibraries
in interfaceIconManager
- Returns:
- The map of all icon library names and their respective icon names
-
digests
public java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonObject> digests()
-
getLibrary
@Nonnull public java.util.Optional<java.lang.String> getLibrary(@Nullable java.lang.String libraryName)
Description copied from interface:IconManager
Fetch the raw icon library as an SVG String- Specified by:
getLibrary
in interfaceIconManager
- Parameters:
libraryName
- The name of the icon library to fetch- Returns:
- An optional String whose contents are an SVG containing the library's icons, or an empty Optional if an icon library with the given name does not exist
-
getLibDigest
public java.util.Optional<java.lang.String> getLibDigest(java.lang.String libraryKey)
-
-