li.cil.manual.api.prefab.manual

Class ResourceContentProvider

java.lang.Object

li.cil.manual.api.prefab.manual.ResourceContentProvider

All Implemented Interfaces:

ContentProvider

public class ResourceContentProvider
extends java.lang.Object
implements ContentProvider

Basic implementation of a content provider based on Minecraft's resource loading framework.

Beware that the manual is unaware of resource domains. In other words, two paths that are identical except for their resource domain will be the same, as seen from the manual. This means you should probably place your documentation somewhere other than doc/, because that's where the RTFM documentation lives, and it is queried first - meaning if you have a page with the same path as one in RTFM, it is practically unreachable (because the OC provider is always queried first).

Constructor Summary

Constructors

Constructor and Description
ResourceContentProvider(java.lang.String resourceDomain)
ResourceContentProvider(java.lang.String resourceDomain, java.lang.String basePath)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getContent(java.lang.String path) Called to get the content of a path pointed to by the specified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceContentProvider

public ResourceContentProvider(java.lang.String resourceDomain,
                               java.lang.String basePath)

ResourceContentProvider

public ResourceContentProvider(java.lang.String resourceDomain)

Method Detail

getContent

@Nullable
public java.lang.Iterable<java.lang.String> getContent(java.lang.String path)

Description copied from interface: ContentProvider

Called to get the content of a path pointed to by the specified path.

This should provide an iterable over the lines of a Markdown document (with the formatting provided by the in-game manual, which is a small subset of "normal" Markdown).

If this provider cannot provide the requested path, it should return null to indicate so, allowing other providers to be queried.

Specified by:

getContent in interface ContentProvider

Parameters:

path - the path to the manual page we're looking for.

Returns:

the content of the document at that path, or null.