Module org.basinmc.lavatory

Package org.basinmc.lavatory.asset

Class AssetIndex

java.lang.Object

org.basinmc.lavatory.asset.AssetIndex

public class AssetIndex
extends Object

Represents an index of resource files.

Author:

Johannes Donath

Constructor Summary

Constructors

Constructor	Description
AssetIndex(Map<String,AssetObject> objects)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<AssetObject>	getObject(String path)	Retrieves a specific object from the index.
Map<String,AssetObject>	getObjects()
int	hashCode()
static AssetIndex	read(InputStream inputStream)	Decodes an asset index from the specified input stream.
static AssetIndex	read(Reader reader)	Decodes an asset index from the specified reader.
static AssetIndex	read(Path path)	Decodes an asset index from the specified file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetIndex

public AssetIndex(@NonNull
                  Map<String,AssetObject> objects)

Method Detail

getObject

@NonNull
public Optional<AssetObject> getObject(@NonNull
                                       String path)

Retrieves a specific object from the index.

Parameters:

path - a relative path.

Returns:

an asset object or, if no such object exists, an empty optional.

getObjects

@NonNull
public Map<String,AssetObject> getObjects()

read

@NonNull
public static AssetIndex read(@NonNull
                              InputStream inputStream)
                       throws IOException

Decodes an asset index from the specified input stream.

Parameters:

inputStream - an input stream.

Returns:

an asset index.

Throws:

IOException - when reading from the input stream fails or the data is malformed.

read

@NonNull
public static AssetIndex read(@NonNull
                              Path path)
                       throws IOException

Decodes an asset index from the specified file.

Parameters:

path - a file path.

Returns:

an asset index.

Throws:

IOException - when reading from the file fails or the data is malformed.

read

@NonNull
public static AssetIndex read(@NonNull
                              Reader reader)
                       throws IOException

Decodes an asset index from the specified reader.

Parameters:

reader - a reader.

Returns:

an asset index.

Throws:

IOException - when reading from the file fails or the data is malformed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object