com.inductiveautomation.ignition.common.modules

Class ModuleInfo.JarInfo

java.lang.Object

com.inductiveautomation.ignition.common.modules.ModuleInfo.JarInfo

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ModuleInfo

public static class ModuleInfo.JarInfo
extends java.lang.Object
implements java.io.Serializable

Contains meta information about a module's jar file, such as its scope and native lib parameters, and path within the module package.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JarInfo(int scope, java.lang.String path)
JarInfo(int scope, java.lang.String path, java.lang.String requiredOS, java.lang.String requiredArch)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath()
java.lang.String	getRequiredArch() Get the required architecture for the jar.
java.lang.String	getRequiredOS() Get the required OS for the jar.
int	getScope()
boolean	isNativeLib()
boolean	isRequiredArchitecture(Platform.Architecture arch)
boolean	isRequiredOS(Platform.OperatingSystem os)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JarInfo

public JarInfo(int scope,
               java.lang.String path)

JarInfo

public JarInfo(int scope,
               java.lang.String path,
               java.lang.String requiredOS,
               java.lang.String requiredArch)

Method Detail

getScope

public int getScope()

getPath

public java.lang.String getPath()

getRequiredOS

public java.lang.String getRequiredOS()

Get the required OS for the jar. Empty string should be interpreted as "any is okay."

Returns:

Comma-delimited list of required operating systems

getRequiredArch

public java.lang.String getRequiredArch()

Get the required architecture for the jar. Empty string should be interpreted as "any is okay."

Returns:

Comma-delimited list of required operating architectures

isRequiredOS

public boolean isRequiredOS(Platform.OperatingSystem os)

Parameters:

os -

Returns:

True if os is a member of required os set or no particular os is required

isRequiredArchitecture

public boolean isRequiredArchitecture(Platform.Architecture arch)

Parameters:

arch -

Returns:

True if arch is a member of required os set or no particular arch is required

isNativeLib

public boolean isNativeLib()

Returns:

True if jar requires a particular OS or architecture