Module org.spongepowered.plugin.metadata.mcmodinfo

Package org.spongepowered.plugin.meta

Class McModInfo

java.lang.Object

org.spongepowered.plugin.meta.McModInfo

public final class McModInfo
extends Object

Represents a serializer for PluginMetadata for the mcmod.info file format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McModInfo.Builder	Represents a builder for McModInfo serializes that can be used to construct a serializer that serializes specific extension keys to their Java object representation.

Field Summary

Fields

Modifier and Type	Field	Description
static final McModInfo	DEFAULT	The default serializer that converts all additional properties into standard Java types.
static final String	STANDARD_FILENAME	The file name the metadata is usually saved in.

Method Summary

Modifier and Type	Method	Description
static McModInfo.Builder	builder()	Creates a new McModInfo.Builder that can be used to construct a McModInfo serializer that serializes specific extension keys to their Java object representation.
List<PluginMetadata>	fromJson(String json)	Deserializes the specified JSON string into a List of PluginMetadata.
List<PluginMetadata>	read(JsonReader reader)	Reads a List of PluginMetadata from the given JsonReader.
List<PluginMetadata>	read(InputStream in)	Reads a List of PluginMetadata from the given InputStream.
List<PluginMetadata>	read(Reader reader)	Reads a List of PluginMetadata from the given Reader.
List<PluginMetadata>	read(Path path)	Reads a List of PluginMetadata from the file represented by the specified Path.
String	toJson(List<PluginMetadata> meta)	Serializes the specified List of PluginMetadata to a JSON string.
String	toJson(PluginMetadata... meta)	Serializes the specified PluginMetadata to a JSON string.
void	write(JsonWriter writer, List<PluginMetadata> meta)	Writes the specified List of PluginMetadata to the JsonWriter.
void	write(JsonWriter writer, PluginMetadata... meta)	Writes the specified PluginMetadata to the JsonWriter.
void	write(Writer writer, List<PluginMetadata> meta)	Writes the specified List of PluginMetadata to the Writer.
void	write(Writer writer, PluginMetadata... meta)	Writes the specified PluginMetadata to the Writer.
void	write(Path path, List<PluginMetadata> meta)	Writes the specified List of PluginMetadata to the file represented by the Path.
void	write(Path path, PluginMetadata... meta)	Writes the specified PluginMetadata to the file represented by the Path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STANDARD_FILENAME

public static final String STANDARD_FILENAME

The file name the metadata is usually saved in.

See Also:

• Constant Field Values

DEFAULT

public static final McModInfo DEFAULT

The default serializer that converts all additional properties into standard Java types.

Method Details

fromJson

public List<PluginMetadata> fromJson(String json)

Deserializes the specified JSON string into a List of PluginMetadata.

Parameters:

json - The JSON string

Returns:

The deserialized metadata list

read

public List<PluginMetadata> read(Path path)
                          throws IOException

Reads a List of PluginMetadata from the file represented by the specified Path.

Parameters:

path - The path to the file

Returns:

The deserialized metadata list

Throws:

IOException - If an error occurs while reading

read

public List<PluginMetadata> read(InputStream in)
                          throws IOException

Reads a List of PluginMetadata from the given InputStream.

Parameters:

in - The input stream

Returns:

The deserialized metadata list

Throws:

IOException - If an error occurs while reading

read

public List<PluginMetadata> read(Reader reader)
                          throws IOException

Reads a List of PluginMetadata from the given Reader.

Parameters:

reader - The reader

Returns:

The deserialized metadata list

Throws:

IOException - If an error occurs while reading

read

public List<PluginMetadata> read(JsonReader reader)
                          throws IOException

Reads a List of PluginMetadata from the given JsonReader.

Parameters:

reader - The JSON reader

Returns:

The deserialized metadata list

Throws:

IOException - If an error occurs while reading

toJson

public String toJson(PluginMetadata... meta)

Serializes the specified PluginMetadata to a JSON string.

Parameters:

meta - The plugin metadata to serialize

Returns:

The serialized JSON string

toJson

public String toJson(List<PluginMetadata> meta)

Serializes the specified List of PluginMetadata to a JSON string.

Parameters:

meta - The plugin metadata to serialize

Returns:

The serialized JSON string

write

public void write(Path path,
 PluginMetadata... meta)
           throws IOException

Writes the specified PluginMetadata to the file represented by the Path.

Parameters:

path - The path to the file to write to

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

write

public void write(Path path,
 List<PluginMetadata> meta)
           throws IOException

Writes the specified List of PluginMetadata to the file represented by the Path.

Parameters:

path - The path to the file to write to

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

write

public void write(Writer writer,
 PluginMetadata... meta)
           throws IOException

Writes the specified PluginMetadata to the Writer.

Parameters:

writer - The writer

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

write

public void write(Writer writer,
 List<PluginMetadata> meta)
           throws IOException

Writes the specified List of PluginMetadata to the Writer.

Parameters:

writer - The writer

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

write

public void write(JsonWriter writer,
 PluginMetadata... meta)
           throws IOException

Writes the specified PluginMetadata to the JsonWriter.

Parameters:

writer - The JSON writer

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

write

public void write(JsonWriter writer,
 List<PluginMetadata> meta)
           throws IOException

Writes the specified List of PluginMetadata to the JsonWriter.

Parameters:

writer - The JSON writer

meta - The plugin metadata to serialize

Throws:

IOException - If an error occurs while writing

builder

public static McModInfo.Builder builder()

Creates a new McModInfo.Builder that can be used to construct a McModInfo serializer that serializes specific extension keys to their Java object representation.

Returns:

A new builder