Dependency (Module System API)

java.lang.Object
- org.openide.modules.Dependency

All Implemented Interfaces:

java.io.Serializable
```
public final class Dependency
extends java.lang.Object
implements java.io.Serializable
```
A dependency a module can have. Since version 7.10 this class is Serializable.

Since:

1.24

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`COMPARE_ANY`	No comparison, just require the dependency to be present.
`static int`	`COMPARE_IMPL`	Comparison by implementation version.
`static int`	`COMPARE_SPEC`	Comparison by specification version.
`static java.lang.String`	`IDE_IMPL`	Deprecated. request dependencies on direct modules
`static java.lang.String`	`IDE_NAME`	Deprecated. request dependencies on direct modules
`static SpecificationVersion`	`IDE_SPEC`	Deprecated. request dependencies on direct modules
`static java.lang.String`	`JAVA_IMPL`	Implementation version of the Java platform.
`static java.lang.String`	`JAVA_NAME`	Name, for purposes of dependencies, of the Java platform.
`static SpecificationVersion`	`JAVA_SPEC`	Specification version of the Java platform.
`static int`	`TYPE_IDE`	Deprecated. This type of dependency should no longer be used.
`static int`	`TYPE_JAVA`	Dependency on Java.
`static int`	`TYPE_MODULE`	Dependency on another module.
`static int`	`TYPE_NEEDS`	Dependency on a token, but without need to have token provider be initialised sooner.
`static int`	`TYPE_PACKAGE`	Dependency on a package.
`static int`	`TYPE_RECOMMENDS`	An advisory dependency on a token.
`static int`	`TYPE_REQUIRES`	Dependency on a token.
`static java.lang.String`	`VM_IMPL`	Implementation version of the Java VM.
`static java.lang.String`	`VM_NAME`	Name, for purposes of dependencies, of the Java VM.
`static SpecificationVersion`	`VM_SPEC`	Specification version of the Java VM.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static java.util.Set<Dependency>`	`create(int type, java.lang.String body)`	Parse dependencies from tags.
`boolean`	`equals(java.lang.Object o)`	Overridden to compare contents.
`int`	`getComparison()`	Get the comparison type.
`java.lang.String`	`getName()`	Get the name of the depended-on object.
`int`	`getType()`	Get the type.
`java.lang.String`	`getVersion()`	Get the version to compare against (or null).
`int`	`hashCode()`	Overridden to hash by contents.
`java.lang.String`	`toString()`	Unspecified string representation for debugging.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_MODULE
```
public static final int TYPE_MODULE
```
    Dependency on another module.
    
    See Also:
    
    Constant Field Values
  - TYPE_PACKAGE
```
public static final int TYPE_PACKAGE
```
    Dependency on a package.
    
    See Also:
    
    Constant Field Values
  - TYPE_JAVA
```
public static final int TYPE_JAVA
```
    Dependency on Java.
    
    See Also:
    
    Constant Field Values
  - TYPE_IDE
```
@Deprecated
public static final int TYPE_IDE
```
    Deprecated. This type of dependency should no longer be used.
    
    Dependency on the IDE.
    
    See Also:
    
    Constant Field Values
  - TYPE_REQUIRES
```
public static final int TYPE_REQUIRES
```
    Dependency on a token.
    
    Since:
    
    2.3
    
    See Also:
    
    ModuleInfo.getProvides(), Constant Field Values
  - TYPE_NEEDS
```
public static final int TYPE_NEEDS
```
    Dependency on a token, but without need to have token provider be initialised sooner.
    
    Since:
    
    7.1
    
    See Also:
    
    ModuleInfo.getProvides(), Constant Field Values
  - TYPE_RECOMMENDS
```
public static final int TYPE_RECOMMENDS
```
    An advisory dependency on a token. If at least one provider of such token is available, it is enabled. If there is no such provider, then nothing is done or reported.
    
    Since:
    
    7.1
    
    See Also:
    
    ModuleInfo.getProvides(), Constant Field Values
  - COMPARE_SPEC
```
public static final int COMPARE_SPEC
```
    Comparison by specification version.
    
    See Also:
    
    Constant Field Values
  - COMPARE_IMPL
```
public static final int COMPARE_IMPL
```
    Comparison by implementation version.
    
    See Also:
    
    Constant Field Values
  - COMPARE_ANY
```
public static final int COMPARE_ANY
```
    No comparison, just require the dependency to be present.
    
    See Also:
    
    Constant Field Values
  - IDE_NAME
```
@Deprecated
public static final java.lang.String IDE_NAME
```
    Deprecated. request dependencies on direct modules
  - IDE_SPEC
```
@Deprecated
public static final SpecificationVersion IDE_SPEC
```
    Deprecated. request dependencies on direct modules
  - IDE_IMPL
```
@Deprecated
public static final java.lang.String IDE_IMPL
```
    Deprecated. request dependencies on direct modules
  - JAVA_NAME
```
public static final java.lang.String JAVA_NAME
```
    Name, for purposes of dependencies, of the Java platform.
    
    See Also:
    
    Constant Field Values
  - JAVA_SPEC
```
public static final SpecificationVersion JAVA_SPEC
```
    Specification version of the Java platform.
  - JAVA_IMPL
```
public static final java.lang.String JAVA_IMPL
```
    Implementation version of the Java platform.
  - VM_NAME
```
public static final java.lang.String VM_NAME
```
    Name, for purposes of dependencies, of the Java VM.
    
    See Also:
    
    Constant Field Values
  - VM_SPEC
```
public static final SpecificationVersion VM_SPEC
```
    Specification version of the Java VM.
  - VM_IMPL
```
public static final java.lang.String VM_IMPL
```
    Implementation version of the Java VM.
- Method Detail
  - create
```
public static java.util.Set<Dependency> create(int type,
                                               java.lang.String body)
                                        throws java.lang.IllegalArgumentException
```
    Parse dependencies from tags. Since version 7.32 it can parse code names that contain numbers like org.apache.servicemix.specs.jsr303_api_1.0.0.
    
    Parameters:
    
    type - like Dependency.type
    
    body - actual text of tag body; if null, returns nothing
    
    Returns:
    
    a set of dependencies
    
    Throws:
    
    java.lang.IllegalArgumentException - if they are malformed or inconsistent
  - getType
```
public final int getType()
```
    Get the type.
  - getName
```
public final java.lang.String getName()
```
    Get the name of the depended-on object.
  - getComparison
```
public final int getComparison()
```
    Get the comparison type.
  - getVersion
```
public final java.lang.String getVersion()
```
    Get the version to compare against (or null).
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overridden to compare contents.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overridden to hash by contents.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Unspecified string representation for debugging.
    
    Overrides:
    
    toString in class java.lang.Object

Class Dependency

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_MODULE

TYPE_PACKAGE

TYPE_JAVA

TYPE_IDE

TYPE_REQUIRES

TYPE_NEEDS

TYPE_RECOMMENDS

COMPARE_SPEC

COMPARE_IMPL

COMPARE_ANY

IDE_NAME

IDE_SPEC

IDE_IMPL

JAVA_NAME

JAVA_SPEC

JAVA_IMPL

VM_NAME

VM_SPEC

VM_IMPL

Method Detail

create

getType

getName

getComparison

getVersion

equals

hashCode

toString