Package org.sgrewritten.stargate.network

Class StargateNetwork

java.lang.Object

org.sgrewritten.stargate.network.StargateNetwork

All Implemented Interfaces:

Network

public class StargateNetwork
extends Object
implements Network

A network of portals

Constructor Summary

Constructors

Constructor	Description
StargateNetwork(String name, Set<PortalFlag> flags, StorageType storageType)	Instantiates a new network
StargateNetwork(String name, NetworkType type, StorageType storageType)

Method Summary

Modifier and Type	Method	Description
void	addPortal(Portal portal)	Adds the given portal to this network
void	assignToRegistry(RegistryAPI registry)	Assign the network to a registry
boolean	canSeePortal(Portal portalToSee, Portal origin, org.bukkit.entity.Player player)	Whether the origin portal can list / choose the portal to see.
void	destroy()	Destroys this network and every portal contained in it
Collection<Portal>	getAllPortals()	Gets all portals belonging to this network
Set<String>	getAvailablePortals(org.bukkit.entity.Player player, Portal requester)	Gets names of all portals available to the given player from the given portal
HighlightingStyle	getHighlightingStyle()	Gets the style this network should be highlighted with by default
String	getId()	Gets the unique identifier for this network
String	getName()	Gets the name of this network
PluginMessageSender	getPluginMessageSender()
Portal	getPortal(String name)	Gets the portal with the given name
StorageType	getStorageType()	Gets how the network is stored
NetworkType	getType()	Gets the NetworkType of this network
boolean	isPortalNameTaken(String name)	Checks whether there is already a portal in this network with the given name
void	removePortal(Portal portal)	Removes the given portal from this network
void	renamePortal(String newName, String oldName)	Renames the portal, does not save to database and is also not cross server compatible.
void	setID(String newName)	Change the name of the network
int	size()	Gets the current number of portals in this network
void	updatePortals()	Updates all portals in this network

Methods inherited from class java.lang.Object

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

Constructor Details

StargateNetwork

public StargateNetwork(String name,
 Set<PortalFlag> flags,
 StorageType storageType)
                throws InvalidNameException,
NameLengthException,
UnimplementedFlagException

Instantiates a new network

Parameters:

name -

The name of the new network

flags -

The flags attached to this network

Throws:

InvalidNameException -

If the network name is invalid

NameLengthException

UnimplementedFlagException

StargateNetwork

public StargateNetwork(String name,
 NetworkType type,
 StorageType storageType)
                throws InvalidNameException,
NameLengthException,
UnimplementedFlagException

Throws:

InvalidNameException

NameLengthException

UnimplementedFlagException

Method Details

getId

public String getId()

Description copied from interface: Network

Gets the unique identifier for this network

Specified by:

getId in interface Network

Returns:

The unique identifier for this network

getAllPortals

public Collection<Portal> getAllPortals()

Description copied from interface: Network

Gets all portals belonging to this network

Specified by:

getAllPortals in interface Network

Returns:

All portals belonging to this network

getPortal

public Portal getPortal(String name)

Description copied from interface: Network

Gets the portal with the given name

Specified by:

getPortal in interface Network

Parameters:

name -

The name of the portal to get

Returns:

The portal with the given name, or null if not found

removePortal

public void removePortal(Portal portal)

Description copied from interface: Network

Removes the given portal from this network

Specified by:

removePortal in interface Network

Parameters:

portal -

The portal to remove

addPortal

public void addPortal(Portal portal)
               throws NameConflictException

Description copied from interface: Network

Adds the given portal to this network

Specified by:

addPortal in interface Network

Parameters:

portal -

The portal to add

Throws:

NameConflictException -

if portal a portal with that name already exist in the network

isPortalNameTaken

public boolean isPortalNameTaken(String name)

Description copied from interface: Network

Checks whether there is already a portal in this network with the given name

Specified by:

isPortalNameTaken in interface Network

Parameters:

name -

The name to check for

Returns:

True if an existing portal is already using the given name

updatePortals

public void updatePortals()

Description copied from interface: Network

Updates all portals in this network

Specified by:

updatePortals in interface Network

getAvailablePortals

public Set<String> getAvailablePortals(org.bukkit.entity.Player player,
 Portal requester)

Description copied from interface: Network

Gets names of all portals available to the given player from the given portal

Specified by:

getAvailablePortals in interface Network

Parameters:

player -

The player to get portals

requester -

The portal the player is viewing other portals from

Returns:

The names of all portals the player is allowed to see

canSeePortal

public boolean canSeePortal(Portal portalToSee,
 Portal origin,
 org.bukkit.entity.Player player)

Description copied from interface: Network

Whether the origin portal can list / choose the portal to see.

Specified by:

canSeePortal in interface Network

Parameters:

portalToSee -

The portal to see

origin -

The requesting portal

player -

The actor initiating this request

Returns:

True if the origin portal and player has permission

getHighlightingStyle

public HighlightingStyle getHighlightingStyle()

Description copied from interface: Network

Gets the style this network should be highlighted with by default

Specified by:

getHighlightingStyle in interface Network

Returns:

The highlighting style of this network

destroy

public void destroy()

Description copied from interface: Network

Destroys this network and every portal contained in it

Specified by:

destroy in interface Network

getName

public String getName()

Description copied from interface: Network

Gets the name of this network

Specified by:

getName in interface Network

Returns:

The name of this network

size

public int size()

Description copied from interface: Network

Gets the current number of portals in this network

Specified by:

size in interface Network

Returns:

The size of this network

assignToRegistry

public void assignToRegistry(RegistryAPI registry)

Description copied from interface: Network

Assign the network to a registry

Specified by:

assignToRegistry in interface Network

Parameters:

registry -

The registry API to register to

getType

public NetworkType getType()

Description copied from interface: Network

Gets the NetworkType of this network

Specified by:

getType in interface Network

Returns:

The NetworkType of this network

getStorageType

public StorageType getStorageType()

Description copied from interface: Network

Gets how the network is stored

Specified by:

getStorageType in interface Network

Returns:

The storage type of the portal

setID

public void setID(String newName)
           throws InvalidNameException,
NameLengthException,
UnimplementedFlagException

Description copied from interface: Network

Change the name of the network

Does not save to database. Use NetworkManager.rename(Network, String) instead.

Specified by:

setID in interface Network

Parameters:

newName -

The new name of the network

Throws:

InvalidNameException

NameLengthException

UnimplementedFlagException

getPluginMessageSender

public PluginMessageSender getPluginMessageSender()

Specified by:

getPluginMessageSender in interface Network

Returns:

The plugin message sender

renamePortal

public void renamePortal(String newName,
 String oldName)
                  throws InvalidNameException

Description copied from interface: Network

Renames the portal, does not save to database and is also not cross server compatible. Instead use NetworkManager.rename(Portal, String)

Specified by:

renamePortal in interface Network

Parameters:

newName -

oldName -

Throws:

InvalidNameException