JPF 0.10

org.java.plugin.registry
Interface PluginPrerequisite

All Superinterfaces:
Documentable, Identity, PluginElement, UniqueIdentity

public interface PluginPrerequisite
extends UniqueIdentity, PluginElement

This interface abstracts inter plug-ins dependencies.

Plug-in prerequisite UID is a combination of declaring plug-in ID and prerequisite ID (may be auto-generated) that is unique within whole set of registered plug-ins.

Version:
$Id: PluginPrerequisite.java,v 1.3 2006/02/17 19:39:27 ddimon Exp $

Field Summary
static java.lang.String MATCH_COMPATIBLE
          Version identifier matching mode.
static java.lang.String MATCH_EQUAL
          Version identifier matching mode.
static java.lang.String MATCH_EQUIVALENT
          Version identifier matching mode.
static java.lang.String MATCH_GREATER_OR_EQUAL
          Version identifier matching mode.
 
Method Summary
 java.lang.String getMatch()
           
 java.lang.String getPluginId()
           
 Version getPluginVersion()
           
 boolean isExported()
           
 boolean isOptional()
           
 boolean matches()
           
 
Methods inherited from interface org.java.plugin.registry.UniqueIdentity
getUniqueId
 
Methods inherited from interface org.java.plugin.registry.Identity
getId
 
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
 
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
 

Field Detail

MATCH_EQUAL

public static final java.lang.String MATCH_EQUAL
Version identifier matching mode.

See Also:
Constant Field Values

MATCH_EQUIVALENT

public static final java.lang.String MATCH_EQUIVALENT
Version identifier matching mode.

See Also:
Constant Field Values

MATCH_COMPATIBLE

public static final java.lang.String MATCH_COMPATIBLE
Version identifier matching mode.

See Also:
Constant Field Values

MATCH_GREATER_OR_EQUAL

public static final java.lang.String MATCH_GREATER_OR_EQUAL
Version identifier matching mode.

See Also:
Constant Field Values
Method Detail

getPluginId

public java.lang.String getPluginId()
Returns:
ID of plug-in, this plug-in depends on

getPluginVersion

public Version getPluginVersion()
Returns:
desired plug-in version identifier or null if not specified

isExported

public boolean isExported()
Returns:
true if this prerequisite is propagated on depending plug-ins

isOptional

public boolean isOptional()
Returns:
true if this prerequisite is not required

matches

public boolean matches()
Returns:
true if this prerequisite is fulfilled

getMatch

public java.lang.String getMatch()
Returns:
the match rule as it specified in manifest

JPF 0.10

Copyright © 2004-2005 Dmitry Olshansky. All Rights Reserved.