com.sk89q.worldguard.commands.region

Class RegionPrintoutBuilder

java.lang.Object

com.sk89q.worldguard.commands.region.RegionPrintoutBuilder

All Implemented Interfaces:

java.util.concurrent.Callable<com.sk89q.worldedit.util.formatting.text.TextComponent>

public class RegionPrintoutBuilder
extends java.lang.Object
implements java.util.concurrent.Callable<com.sk89q.worldedit.util.formatting.text.TextComponent>

Create a region printout, as used in /region info to show information about a region.

Constructor Summary

Constructors

Constructor and Description
RegionPrintoutBuilder(java.lang.String world, ProtectedRegion region, com.sk89q.squirrelid.cache.ProfileCache cache, com.sk89q.worldedit.extension.platform.Actor actor) Create a new instance with a region to report on.

Method Summary

Modifier and Type	Method and Description
com.sk89q.worldedit.util.formatting.component.TextComponentProducer	append(java.lang.String str)
com.sk89q.worldedit.util.formatting.component.TextComponentProducer	append(com.sk89q.worldedit.util.formatting.text.TextComponent component)
void	appendBasics() Add region name, type, and priority.
void	appendBounds() Add information about coordinates.
void	appendDomain() Add information about members.
void	appendFlags() Add information about flags.
void	appendFlagsList(boolean useColors) Append just the list of flags (without "Flags:"), including colors.
void	appendParents() Add information about parents.
void	appendParentTree(boolean useColors) Add information about parents.
com.sk89q.worldedit.util.formatting.text.TextComponent	call()
void	newline() Add a new line.
void	send(com.sk89q.worldedit.extension.platform.Actor sender) Send the report to a Actor.
com.sk89q.worldedit.util.formatting.text.TextComponent	toComponent()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionPrintoutBuilder

public RegionPrintoutBuilder(java.lang.String world,
                             ProtectedRegion region,
                             @Nullable
                             com.sk89q.squirrelid.cache.ProfileCache cache,
                             @Nullable
                             com.sk89q.worldedit.extension.platform.Actor actor)

Create a new instance with a region to report on.

Parameters:

region - the region

cache - a profile cache, or null

Method Detail

newline

public void newline()

Add a new line.

appendBasics

public void appendBasics()

Add region name, type, and priority.

appendFlags

public void appendFlags()

Add information about flags.

appendFlagsList

public void appendFlagsList(boolean useColors)

Append just the list of flags (without "Flags:"), including colors.

Parameters:

useColors - true to use colors

appendParents

public void appendParents()

Add information about parents.

appendParentTree

public void appendParentTree(boolean useColors)

Add information about parents.

Parameters:

useColors - true to use colors

appendDomain

public void appendDomain()

Add information about members.

appendBounds

public void appendBounds()

Add information about coordinates.

call

public com.sk89q.worldedit.util.formatting.text.TextComponent call()

Specified by:

call in interface java.util.concurrent.Callable<com.sk89q.worldedit.util.formatting.text.TextComponent>

send

public void send(com.sk89q.worldedit.extension.platform.Actor sender)

Send the report to a Actor.

Parameters:

sender - the recipient

append

public com.sk89q.worldedit.util.formatting.component.TextComponentProducer append(java.lang.String str)

append

public com.sk89q.worldedit.util.formatting.component.TextComponentProducer append(com.sk89q.worldedit.util.formatting.text.TextComponent component)

toComponent

public com.sk89q.worldedit.util.formatting.text.TextComponent toComponent()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object