Index

A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(PluginMetadata) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Replaces the properties in this PluginMetadata with all properties of the specified PluginMetadata that are not empty.
addAuthor(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Adds an author to the List of authors for this plugin.
addAuthors(String...) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Adds the authors to the List of authors for this plugin.
addDependencies(PluginDependency...) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Adds the list of PluginDependency to this PluginMetadata.
addDependency(PluginDependency) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Adds a new PluginDependency to this PluginMetadata.
AFTER - Enum constant in enum org.spongepowered.plugin.meta.PluginDependency.LoadOrder
The dependency should be loaded after the plugin.
ArtifactVersion - Interface in org.spongepowered.plugin.meta.version
 
asOptional() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns a new PluginDependency that has PluginDependency.optional() set to true.
asRequired() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns a new PluginDependency that has PluginDependency.optional() set to false.
authors() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns a mutable List of authors for this plugin.

B

BEFORE - Enum constant in enum org.spongepowered.plugin.meta.PluginDependency.LoadOrder
The dependency should be loaded before the plugin.
build() - Method in class org.spongepowered.plugin.meta.McModInfo.Builder
Builds the McModInfo serializer using the specified options.
builder() - Static method in class org.spongepowered.plugin.meta.McModInfo
Creates a new McModInfo.Builder that can be used to construct a McModInfo serializer that serializes specific extension keys to their Java object representation.

C

cloneOf() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
collectRequiredDependencies() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Collects all dependencies of this PluginMetadata that are not optional.
ComparableVersion - Class in org.spongepowered.plugin.meta.version
Generic implementation of version comparison.
ComparableVersion(String) - Constructor for class org.spongepowered.plugin.meta.version.ComparableVersion
 
compareTo(ArtifactVersion) - Method in class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
compareTo(ComparableVersion) - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
containsVersion(ArtifactVersion) - Method in class org.spongepowered.plugin.meta.version.Restriction
 
containsVersion(ArtifactVersion) - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
createFromVersion(String) - Static method in class org.spongepowered.plugin.meta.version.VersionRange
 
createFromVersionSpec(String) - Static method in class org.spongepowered.plugin.meta.version.VersionRange
Create a version range from a string representation Some spec examples are 1.0 Version 1.0 [1.0,2.0) Versions 1.0 (included) to 2.0 (not included) [1.0,2.0] Versions 1.0 to 2.0 (both included) [1.5,) Versions 1.5 and higher (,1.0],[1.2,) Versions up to 1.0 (included) and 1.2 or higher

D

DEFAULT - Static variable in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
DEFAULT - Static variable in class org.spongepowered.plugin.meta.gson.ModMetadataCollectionAdapter
 
DEFAULT - Static variable in class org.spongepowered.plugin.meta.McModInfo
The default serializer that converts all additional properties into standard Java types.
DefaultArtifactVersion - Class in org.spongepowered.plugin.meta.version
 
DefaultArtifactVersion(String) - Constructor for class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
dependencies() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns a Collection with all dependencies of the plugin represented by this PluginMetadata.
dependenciesById() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns a Map with all dependencies grouped by their plugin ID.
dependency(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the PluginDependency that is currently associated with the specified plugin ID.
description() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the plugin description.

E

equals(Object) - Method in class org.spongepowered.plugin.meta.PluginDependency
 
equals(Object) - Method in class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
equals(Object) - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
equals(Object) - Method in class org.spongepowered.plugin.meta.version.Restriction
 
equals(Object) - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
EVERYTHING - Static variable in class org.spongepowered.plugin.meta.version.Restriction
 
extension(String) - Method in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
extensions() - Method in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
extensions() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns a Map with additional properties for this PluginMetadata.

F

fromJson(String) - Method in class org.spongepowered.plugin.meta.McModInfo
Deserializes the specified JSON string into a List of PluginMetadata.

G

getCanonical() - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
getExtension(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the value for a specific extension.
getFirstInteger() - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
Returns the first integer in this ComparableVersion.
getFirstString() - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
Returns the first string in this ComparableVersion.
getLowerBound() - Method in class org.spongepowered.plugin.meta.version.Restriction
 
getRecommendedVersion() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
getRestrictions() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
getUpperBound() - Method in class org.spongepowered.plugin.meta.version.Restriction
 
groupDependenciesByLoadOrder() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Groups the dependencies of this PluginMetadata based on their PluginDependency.LoadOrder.
gson() - Method in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
gson() - Method in class org.spongepowered.plugin.meta.McModInfo.Builder
Returns the GsonBuilder that will be used to build this serializer's Gson instance.

H

hashCode() - Method in class org.spongepowered.plugin.meta.PluginDependency
 
hashCode() - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
hashCode() - Method in class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
hashCode() - Method in class org.spongepowered.plugin.meta.version.Restriction
 
hashCode() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
hasRestrictions() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 

I

id() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns the plugin ID of this PluginDependency.
id() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the plugin ID that is represented by this PluginMetadata.
ID_PATTERN - Static variable in class org.spongepowered.plugin.meta.PluginMetadata
The pattern plugin IDs must match.
InvalidVersionSpecificationException - Exception in org.spongepowered.plugin.meta.version
Occurs when a version is invalid.
InvalidVersionSpecificationException(String) - Constructor for exception org.spongepowered.plugin.meta.version.InvalidVersionSpecificationException
 
isLowerBoundInclusive() - Method in class org.spongepowered.plugin.meta.version.Restriction
 
isUpperBoundInclusive() - Method in class org.spongepowered.plugin.meta.version.Restriction
 

L

loadOrder() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns the order to load the dependency in relation to the plugin.

M

main(String...) - Static method in class org.spongepowered.plugin.meta.version.ComparableVersion
Main to test version parsing and comparison.
matchVersion(List<ArtifactVersion>) - Method in class org.spongepowered.plugin.meta.version.VersionRange
 
McModInfo - Class in org.spongepowered.plugin.meta
Represents a serializer for PluginMetadata for the mcmod.info file format.
McModInfo.Builder - Class in org.spongepowered.plugin.meta
Represents a builder for McModInfo serializes that can be used to construct a serializer that serializes specific extension keys to their Java object representation.
ModMetadataAdapter - Class in org.spongepowered.plugin.meta.gson
 
ModMetadataAdapter(Gson, Map<String, Class<?>>) - Constructor for class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
ModMetadataCollectionAdapter - Class in org.spongepowered.plugin.meta.gson
 
ModMetadataCollectionAdapter(ModMetadataAdapter) - Constructor for class org.spongepowered.plugin.meta.gson.ModMetadataCollectionAdapter
 

N

name() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the plugin name.
NONE - Enum constant in enum org.spongepowered.plugin.meta.PluginDependency.LoadOrder
The plugin and the dependency can be loaded in any order.

O

optional() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns whether the dependency is optional for the plugin to work correctly.
org.spongepowered.plugin.meta - package org.spongepowered.plugin.meta
 
org.spongepowered.plugin.meta.gson - package org.spongepowered.plugin.meta.gson
 
org.spongepowered.plugin.meta.version - package org.spongepowered.plugin.meta.version
 
org.spongepowered.plugin.metadata.mcmodinfo - module org.spongepowered.plugin.metadata.mcmodinfo
 

P

parseVersion(String) - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
PluginDependency - Class in org.spongepowered.plugin.meta
Represents a dependency on another plugin.
PluginDependency(PluginDependency.LoadOrder, String, String, boolean) - Constructor for class org.spongepowered.plugin.meta.PluginDependency
Constructs a new PluginDependency with the given plugin ID and version range.
PluginDependency.LoadOrder - Enum in org.spongepowered.plugin.meta
Defines when the dependency should be loaded in relation to the plugin.
PluginMetadata - Class in org.spongepowered.plugin.meta
Represents additional metadata for a specific version of a plugin.
PluginMetadata(String) - Constructor for class org.spongepowered.plugin.meta.PluginMetadata
Constructs a new PluginMetadata with the specified plugin ID.

R

read(JsonReader) - Method in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
read(JsonReader) - Method in class org.spongepowered.plugin.meta.gson.ModMetadataCollectionAdapter
 
read(JsonReader) - Method in class org.spongepowered.plugin.meta.McModInfo
Reads a List of PluginMetadata from the given JsonReader.
read(InputStream) - Method in class org.spongepowered.plugin.meta.McModInfo
Reads a List of PluginMetadata from the given InputStream.
read(Reader) - Method in class org.spongepowered.plugin.meta.McModInfo
Reads a List of PluginMetadata from the given Reader.
read(Path) - Method in class org.spongepowered.plugin.meta.McModInfo
Reads a List of PluginMetadata from the file represented by the specified Path.
registerExtension(String, Class<?>) - Method in class org.spongepowered.plugin.meta.McModInfo.Builder
Registers an extension with the given key and the specified extension class.
registerExtension(String, Class<?>, Object) - Method in class org.spongepowered.plugin.meta.McModInfo.Builder
Registers an extension with the given key, extension class and a custom type adapter to use for serializing the extension class.
removeAuthor(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Removes an author from the List of authors for this plugin.
removeDependency(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Removes a dependency from this PluginMetadata.
removeExtension(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Removes an extension from this PluginMetadata.
replaceDependency(PluginDependency) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Replaces the current PluginDependency with the same plugin ID with a new one.
restrict(VersionRange) - Method in class org.spongepowered.plugin.meta.version.VersionRange
Creates and returns a new VersionRange that is a restriction of this version range and the specified version range.
Restriction - Class in org.spongepowered.plugin.meta.version
Describes a restriction in versioning.
Restriction(ArtifactVersion, boolean, ArtifactVersion, boolean) - Constructor for class org.spongepowered.plugin.meta.version.Restriction
 

S

setDescription(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Sets the plugin description.
setExtension(String, Object) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Adds the specified extension to this PluginMetadata.
setId(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Sets the plugin ID that is represented by this PluginMetadata.
setName(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Sets the plugin name.
setUrl(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Sets a URL where additional information about a plugin may be found.
setVersion(String) - Method in class org.spongepowered.plugin.meta.PluginMetadata
Sets the plugin version.
STANDARD_FILENAME - Static variable in class org.spongepowered.plugin.meta.McModInfo
The file name the metadata is usually saved in.

T

toJson(List<PluginMetadata>) - Method in class org.spongepowered.plugin.meta.McModInfo
Serializes the specified List of PluginMetadata to a JSON string.
toJson(PluginMetadata...) - Method in class org.spongepowered.plugin.meta.McModInfo
Serializes the specified PluginMetadata to a JSON string.
toString() - Method in class org.spongepowered.plugin.meta.PluginDependency
 
toString() - Method in class org.spongepowered.plugin.meta.PluginMetadata
 
toString() - Method in class org.spongepowered.plugin.meta.version.ComparableVersion
 
toString() - Method in class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
toString() - Method in class org.spongepowered.plugin.meta.version.Restriction
 
toString() - Method in class org.spongepowered.plugin.meta.version.VersionRange
 

U

url() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns a URL where additional information about a plugin may be found.

V

valueOf(String) - Static method in enum org.spongepowered.plugin.meta.PluginDependency.LoadOrder
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.spongepowered.plugin.meta.PluginDependency.LoadOrder
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class org.spongepowered.plugin.meta.PluginDependency
Returns the version range this PluginDependency should match.
version() - Method in class org.spongepowered.plugin.meta.PluginMetadata
Returns the plugin version.
version() - Method in class org.spongepowered.plugin.meta.version.DefaultArtifactVersion
 
VersionRange - Class in org.spongepowered.plugin.meta.version
Construct a version range from a specification.

W

write(JsonWriter, List<PluginMetadata>) - Method in class org.spongepowered.plugin.meta.gson.ModMetadataCollectionAdapter
 
write(JsonWriter, List<PluginMetadata>) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified List of PluginMetadata to the JsonWriter.
write(JsonWriter, PluginMetadata) - Method in class org.spongepowered.plugin.meta.gson.ModMetadataAdapter
 
write(JsonWriter, PluginMetadata...) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified PluginMetadata to the JsonWriter.
write(Writer, List<PluginMetadata>) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified List of PluginMetadata to the Writer.
write(Writer, PluginMetadata...) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified PluginMetadata to the Writer.
write(Path, List<PluginMetadata>) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified List of PluginMetadata to the file represented by the Path.
write(Path, PluginMetadata...) - Method in class org.spongepowered.plugin.meta.McModInfo
Writes the specified PluginMetadata to the file represented by the Path.
A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form