li.cil.manual.client.manual.provider

Class BlockImageProvider

java.lang.Object

li.cil.manual.client.manual.provider.BlockImageProvider

All Implemented Interfaces:

ImageProvider

public final class BlockImageProvider
extends java.lang.Object
implements ImageProvider

Constructor Summary

Constructors

Constructor and Description
BlockImageProvider()

Method Summary

Modifier and Type	Method and Description
ImageRenderer	getImage(java.lang.String data) Gets an image renderer for the specified data.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockImageProvider

public BlockImageProvider()

Method Detail

getImage

@Nullable
public ImageRenderer getImage(java.lang.String data)

Description copied from interface: ImageProvider

Gets an image renderer for the specified data.

The data passed here will be part of the image URL following the prefix that the provider was registered with. So for example, if the provider was registered for the prefix custom, and the image to be rendered in the Markdown document was [blah](custom:the data], then the string passed where would be the data.

If there is no appropriate image renderer (for example, for the built-in item stack renderers: if the item definition is invalid), this should return null, it should never throw an exception.

Specified by:

getImage in interface ImageProvider

Parameters:

data - the data part of the image definition.

Returns:

the image renderer for the data, or null if none exists.