com.alee.managers.plugin.data
Class PluginDependency

java.lang.Object
  extended by com.alee.managers.plugin.data.PluginDependency
All Implemented Interfaces:
java.io.Serializable

public class PluginDependency
extends java.lang.Object
implements java.io.Serializable

Plugin dependency data class. It points to specific plugin which is used by pointing plugin.

Author:
Mikle Garin
See Also:
Serialized Form

Constructor Summary
PluginDependency()
          Constructs new empty dependency.
PluginDependency(java.lang.String pluginId)
          Constructs new dependency.
PluginDependency(java.lang.String pluginId, PluginVersion minVersion)
          Constructs new dependency.
PluginDependency(java.lang.String pluginId, PluginVersion minVersion, PluginVersion maxVersion)
          Constructs new dependency.
PluginDependency(java.lang.String pluginId, PluginVersion minVersion, PluginVersion maxVersion, java.lang.Boolean optional)
          Constructs new dependency.
 
Method Summary
 boolean accept(Plugin plugin)
          Returns whether the specified plugin is accepted by this dependency or not.
 PluginVersion getMaxVersion()
          Returns maximum plugin version.
 PluginVersion getMinVersion()
          Returns minimum plugin version.
 java.lang.Boolean getOptional()
          Returns whether this dependency is mandatory or not.
 java.lang.String getPluginId()
          Returns plugin ID.
 java.lang.String getVersionString(java.lang.String prefix, PluginVersion pluginVersion)
          Returns version string.
 boolean isOptional()
          Returns whether this dependency is mandatory or not.
 void setMaxVersion(PluginVersion maxVersion)
          Sets maximum plugin version.
 void setMinVersion(PluginVersion minVersion)
          Sets minimum plugin version.
 void setOptional(java.lang.Boolean optional)
          Sets whether this dependency is mandatory or not.
 void setPluginId(java.lang.String pluginId)
          Sets plugin ID.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PluginDependency

public PluginDependency()
Constructs new empty dependency.


PluginDependency

public PluginDependency(java.lang.String pluginId)
Constructs new dependency.

Parameters:
pluginId - plugin ID

PluginDependency

public PluginDependency(java.lang.String pluginId,
                        PluginVersion minVersion)
Constructs new dependency.

Parameters:
pluginId - plugin ID
minVersion - minimum plugin version

PluginDependency

public PluginDependency(java.lang.String pluginId,
                        PluginVersion minVersion,
                        PluginVersion maxVersion)
Constructs new dependency.

Parameters:
pluginId - plugin ID
minVersion - minimum plugin version
maxVersion - maximum plugin version

PluginDependency

public PluginDependency(java.lang.String pluginId,
                        PluginVersion minVersion,
                        PluginVersion maxVersion,
                        java.lang.Boolean optional)
Constructs new dependency.

Parameters:
pluginId - plugin ID
minVersion - minimum plugin version
maxVersion - maximum plugin version
optional - whether this dependency is mandatory or not
Method Detail

getPluginId

public java.lang.String getPluginId()
Returns plugin ID.

Returns:
plugin ID

setPluginId

public void setPluginId(java.lang.String pluginId)
Sets plugin ID.

Parameters:
pluginId - plugin ID

getMinVersion

public PluginVersion getMinVersion()
Returns minimum plugin version.

Returns:
minimum plugin version

setMinVersion

public void setMinVersion(PluginVersion minVersion)
Sets minimum plugin version.

Parameters:
minVersion - minimum plugin version

getMaxVersion

public PluginVersion getMaxVersion()
Returns maximum plugin version.

Returns:
maximum plugin version

setMaxVersion

public void setMaxVersion(PluginVersion maxVersion)
Sets maximum plugin version.

Parameters:
maxVersion - maximum plugin version

getOptional

public java.lang.Boolean getOptional()
Returns whether this dependency is mandatory or not.

Returns:
true or null if this dependency is mandatory, false otherwise

isOptional

public boolean isOptional()
Returns whether this dependency is mandatory or not.

Returns:
true if this dependency is mandatory, false otherwise

setOptional

public void setOptional(java.lang.Boolean optional)
Sets whether this dependency is mandatory or not.

Parameters:
optional - whether this dependency is mandatory or not

accept

public boolean accept(Plugin plugin)
Returns whether the specified plugin is accepted by this dependency or not.

Parameters:
plugin - plugin to check
Returns:
true if the specified plugin is accepted by this dependency, false otherwise

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

getVersionString

public java.lang.String getVersionString(java.lang.String prefix,
                                         PluginVersion pluginVersion)
Returns version string.

Parameters:
prefix - version string prefix
pluginVersion - plugin version
Returns:
version string