PluginDependency (velocity-api 4.0.0-SNAPSHOT API)

java.lang.Object
- com.velocitypowered.api.plugin.meta.PluginDependency

public final class PluginDependency
extends Object

Represents a dependency on another plugin.

Constructor Summary

Constructors
Constructor Description

PluginDependency(String id, String version, boolean optional)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(@Nullable Object o)`
`int`	`hashCode()`
`String`	`id()`	Returns the plugin ID of this `PluginDependency`.
`boolean`	`optional()`	Returns whether the dependency is optional for the plugin to work correctly.
`String`	`toString()`
`String`	`version()`	Returns the version this `PluginDependency` should match in NPM SemVer range format.

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

- Constructor Detail
  - PluginDependency
```
public PluginDependency(String id,
                        String version,
                        boolean optional)
```
    Creates a new instance.
    
    Parameters:
    
    id - the plugin ID
    
    version - an optional version
    
    optional - whether or not this dependency is optional
- Method Detail
  - id
```
public String id()
```
    Returns the plugin ID of this PluginDependency.
    
    Returns:
    
    the plugin ID
  - version
```
public String version()
```
    Returns the version this PluginDependency should match in NPM SemVer range format.
    
    Returns:
    
    a String with the plugin version, may be empty if no version requirement is present
  - optional
```
public boolean optional()
```
    Returns whether the dependency is optional for the plugin to work correctly.
    
    Returns:
    
    true if dependency is optional
  - equals
```
public boolean equals(@Nullable Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object