com.datasiqn.commandcore.command.source

Class BlockCommandSource

java.lang.Object

com.datasiqn.commandcore.command.source.BlockCommandSource

All Implemented Interfaces:

CommandSource

public class BlockCommandSource
extends Object
implements CommandSource

Represents a CommandSource where the sender is a BlockCommandSender

NOTE: Do not directly instantiate this class! Instead, use the factory method createSource

Constructor Summary

Constructors

Constructor and Description
BlockCommandSource(org.bukkit.command.BlockCommandSender sender) Creates a new BlockCommandSource with the internal sender of sender.

Method Summary

Modifier and Type	Method and Description
@NotNull com.datasiqn.resultapi.Result<org.bukkit.command.BlockCommandSender,String>	getBlockChecked() Same as CommandSource.getBlock(), except checks if the sender is a command block and returns a Result
@NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String>	getLocatableChecked() Same as CommandSource.getLocatable(), except checks if the sender is locatable and returns a Result
@NotNull org.bukkit.command.CommandSender	getSender() Gets the sender of the command

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datasiqn.commandcore.command.source.CommandSource

getBlock, getEntity, getEntityChecked, getLocatable, getPlayer, getPlayerChecked, hasPermission, hasPermission, sendMessage

Constructor Detail

BlockCommandSource

public BlockCommandSource(org.bukkit.command.BlockCommandSender sender)

Creates a new BlockCommandSource with the internal sender of sender.

NOTE: Do not directly use this constructor! Instead, use the factory method createSource

Parameters:

sender - The BlockCommandSender to internally use

Method Detail

getBlockChecked

@NotNull
public @NotNull com.datasiqn.resultapi.Result<org.bukkit.command.BlockCommandSender,String> getBlockChecked()

Description copied from interface: CommandSource

Same as CommandSource.getBlock(), except checks if the sender is a command block and returns a Result

Specified by:

getBlockChecked in interface CommandSource

Returns:

A result describing the command block. If the command link CommandLink.requiresBlock() requiresCommandBlock}, use CommandSource.getBlock() instead

getLocatableChecked

@NotNull
public @NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String> getLocatableChecked()

Description copied from interface: CommandSource

Same as CommandSource.getLocatable(), except checks if the sender is locatable and returns a Result

Specified by:

getLocatableChecked in interface CommandSource

Returns:

A result describing the locatable sender. If the command link CommandLink.requiresLocatable() requiresCommandBlock}, use CommandSource.getLocatable() instead

getSender

@NotNull
public @NotNull org.bukkit.command.CommandSender getSender()

Description copied from interface: CommandSource

Gets the sender of the command

Specified by:

getSender in interface CommandSource

Returns:

The sender