Interface Delphi

public interface Delphi

Delphi plugin interface.

Method Summary

Modifier and Type	Method	Description
List<DocumentView>	getAllViews()	Gets all document views currently open
Optional<DocumentView>	getAnyTargetedView(@NotNull org.bukkit.entity.Player player)	Get the view currently being looked at by the specified player, regardless of who that view belongs to.
Optional<DocumentView>	getByInstanceName(String instanceName)	Get a document view by its instance name.
List<DocumentView>	getOpenViews(@NotNull org.bukkit.entity.Player player)	Gets all the document views a player has open
DelphiResources	getResources()	Gets the Delphi plugin resources
Optional<DocumentView>	getSelectedView(@NotNull org.bukkit.entity.Player player)	Get the view currently being looked at by the specified player.
@NotNull StylesheetBuilder	newStylesheetBuilder()	Create a new stylesheet builder.
DocumentViewBuilder	newViewBuilder()	Create a new document view builder
Result<DocumentView, DelphiException>	openDocument(@NotNull ResourcePath path, @NotNull org.bukkit.entity.Player player)	Attempts to open the document specified by the path and show it to player.
Result<DocumentView, DelphiException>	openDocument(@NotNull String path, @NotNull org.bukkit.entity.Player player)	Attempts to open the document specified by the path and show it to player.
Result<ResourcePath, DelphiException>	parsePath(String string)	Attempts to parse a path

Method Details

getResources

DelphiResources getResources()

Gets the Delphi plugin resources

Returns:

Delphi plugin resources

newViewBuilder

DocumentViewBuilder newViewBuilder()

Create a new document view builder

Returns:

Created document view builder

parsePath

Result<ResourcePath, DelphiException> parsePath(String string)

Attempts to parse a path

Parameters:

string - Parse string

Returns:

Parse result, either successful, or an error with the error code ERR_INVALID_PATH

See Also:

• ResourcePath

openDocument

Result<DocumentView, DelphiException> openDocument(@NotNull
 @NotNull ResourcePath path,
 @NotNull
 @NotNull org.bukkit.entity.Player player)

Attempts to open the document specified by the path and show it to player.

Uses DelphiResources.findModule(String) to find the module of the path, then creates a ViewResources object with the module and attempts to call ViewResources.loadDocument(String) with the path given to this method.

If the document is successfully loaded and initialized, it is spawned and then shown to the player, and the created document view is returned.

Any erroneous result returned by this method will have an error code dictated by either the DelphiResources.findModule(String) or ViewResources.loadDocument(String) methods.

Parameters:

path - Document path

player - Player to show the document to

Returns:

The opened view, or an error result explaining why the document couldn't be opened.

Throws:

NullPointerException - If path or player are null

See Also:

• DelphiResources.findModule(String)
• ViewResources.loadDocument(String)

openDocument

Result<DocumentView, DelphiException> openDocument(@NotNull
 @NotNull String path,
 @NotNull
 @NotNull org.bukkit.entity.Player player)

Attempts to open the document specified by the path and show it to player.

Uses DelphiResources.findModule(String) to find the module of the path, then creates a ViewResources object with the module and attempts to call ViewResources.loadDocument(String) with the path given to this method.

If the document is successfully loaded and initialized, it is spawned and then shown to the player, and the created document view is returned.

Any erroneous result returned by this method will have an error code dictated by either the DelphiResources.findModule(String), parsePath(String) or ViewResources.loadDocument(String) methods.

Parameters:

path - Document path

player - Player to show the document to

Returns:

The opened view, or an error result explaining why the document couldn't be opened.

Throws:

NullPointerException - If path or player are null

See Also:

• DelphiResources.findModule(String)
• ViewResources.loadDocument(String)
• parsePath(String)

getOpenViews

List<DocumentView> getOpenViews(@NotNull
 @NotNull org.bukkit.entity.Player player)

Gets all the document views a player has open

Parameters:

player - Player

Returns:

Unmodifiable open view list, may be empty.

Throws:

NullPointerException - if player is null

getByInstanceName

Optional<DocumentView> getByInstanceName(String instanceName)

Get a document view by its instance name.

Parameters:

instanceName - Instance name

Returns:

An optional containing the document view with the specified instanceName, or an empty optional, if no view with the specified name exists.

getAllViews

List<DocumentView> getAllViews()

Gets all document views currently open

Returns:

Unmodifiable open view list, may be empty.

getSelectedView

Optional<DocumentView> getSelectedView(@NotNull
 @NotNull org.bukkit.entity.Player player)

Get the view currently being looked at by the specified player.

Parameters:

player - Player

Returns:

An optional containing the view the player is currently looking at, or an empty optional, if the player is not looking at any document views.

Throws:

NullPointerException - If player is null

See Also:

• Accessing any view a player is looking at

getAnyTargetedView

Optional<DocumentView> getAnyTargetedView(@NotNull
 @NotNull org.bukkit.entity.Player player)

Get the view currently being looked at by the specified player, regardless of who that view belongs to.

Unlike getSelectedView(Player) this method will ignore who a view belongs to, and will get the closest view the player is looking at.

Parameters:

player - Player

Returns:

An optional containing the closest the document view the player is looking at, or an empty optional, if the player is not looking at any views.

Throws:

NullPointerException - If player is null

newStylesheetBuilder

@NotNull
@NotNull StylesheetBuilder newStylesheetBuilder()

Create a new stylesheet builder.

Returns:

New stylesheet builder