Class StructureSnapshot

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.structures.StructureSnapshot

All Implemented Interfaces:

IStructureConst, IPropertyHolderConst

@ThreadSafe
public final class StructureSnapshot
extends Object
implements IStructureConst

Represents a (read-only) snapshot of a structure at a particular point in time.

All access to this class is thread safe and does not lock.

Please read the documentation of nl.pim16aap2.animatedarchitecture.core.structures for more information about the structure system.

Method Summary

Modifier and Type	Method	Description
boolean	canMovePerpetually()	Checks if this structure can move perpetually.
void	forEach(Consumer<? super PropertyValuePair<?>> action)
Rectangle	getAnimationRange()	Gets the rectangle describing the limits within an animation of this door takes place.
Cuboid	getCuboid()	Gets the Cuboid representing the area taken up by this structure.
MovementDirection	getCycledOpenDirection()	Cycle the MovementDirection direction this Structure will open in.
double	getMinimumAnimationTime()	Gets the lower time limit for an animation.
String	getName()	Gets the name of this structure.
MovementDirection	getOpenDirection()	Gets the MovementDirection this Structure will open if currently closed.
Optional<StructureOwner>	getOwner(UUID player)	Attempts to get the StructureOwner of this structure represented by the UUID of a player.
Collection<StructureOwner>	getOwners()	Gets all StructureOwners of this structure, including the original creator.
Map<UUID, StructureOwner>	getOwnersMap()
Vector3Di	getPowerBlock()	Gets the position of power block of this structure.
StructureOwner	getPrimeOwner()	Gets the prime owner (permission = 0) of this structure.
IPropertyContainerConst	getPropertyContainerSnapshot()	Gets the PropertyContainerSnapshot of this structure.
<T> IPropertyValue<T>	getPropertyValue(Property<T> property)	Gets the value of the given property.
<T> T	getRequiredPropertyValue(Property<T> property)	Gets the value of a required property.
StructureSnapshot	getSnapshot()	Returns a (read-only) StructureSnapshot of this structure.
StructureType	getType()	Returns the StructureType of this structure.
long	getUid()	Gets the UID of the Structure as used in the database.
IWorld	getWorld()	Gets the IWorld this Structure exists in.
boolean	hasProperties(Collection<Property<?>> properties)	Checks if this property holder has all the given properties.
boolean	hasProperties(SequencedCollection<Property<?>> properties)	Checks if this property holder has all the given properties.
boolean	hasProperties(Property<?>... properties)	Checks if this property holder has all the given properties.
boolean	hasProperty(Property<?> property)	Checks if the given property has a value set.
boolean	isCanMovePerpetually()
boolean	isLocked()	Check if the Structure is currently locked.
boolean	isOwner(UUID player)	Checks if a player with a given UUID is a (co-)owner of this structure with any level of ownership.
boolean	isOwner(UUID uuid, PermissionLevel permissionLevel)	Checks if a player with a given UUID is a (co-)owner of this structure with a given level of ownership.
Iterator<PropertyValuePair<?>>	iterator()
int	propertyCount()	Gets the number of properties in this property container.
Spliterator<PropertyValuePair<?>>	spliterator()
Stream<PropertyValuePair<?>>	stream()
@NonNull String	toString()

Methods inherited from class Object

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

Methods inherited from interface IStructureConst

equals, getBasicInfo, getBlockCount, getChunkId, getDimensions, getMaximum, getMinimum, getNameAndUid, getOwner, getPermissionLevel, getPermissionLevel, isOwner, isOwner

Method Details

getOwner

public Optional<StructureOwner> getOwner(UUID player)

Description copied from interface: IStructureConst

Attempts to get the StructureOwner of this structure represented by the UUID of a player.

Specified by:

getOwner in interface IStructureConst

Parameters:

player - The UUID of the player that may or may not be an owner of this structure.

Returns:

The StructureOwner of this structure for the given player, if this player is a StructureOwner of this structure.

isOwner

public boolean isOwner(UUID player)

Description copied from interface: IStructureConst

Checks if a player with a given UUID is a (co-)owner of this structure with any level of ownership.

If the level of ownership matters, use IStructureConst.getOwner(UUID) instead.

Specified by:

isOwner in interface IStructureConst

Parameters:

player - The UUID of a player.

Returns:

True if the player with the given UUID is an owner of this structure with any level of ownership.

isOwner

public boolean isOwner(UUID uuid,
 PermissionLevel permissionLevel)

Description copied from interface: IStructureConst

Checks if a player with a given UUID is a (co-)owner of this structure with a given level of ownership.

Specified by:

isOwner in interface IStructureConst

Parameters:

uuid - The UUID of a player.

permissionLevel - The maximum level of ownership the player may have.

E.g. when permissionLevel is PermissionLevel.ADMIN, this method will return true if the player has admin access or lower (PermissionLevel.ADMIN or PermissionLevel.CREATOR).

Returns:

True if the player with the given UUID is an owner of this structure with the given level of ownership (or lower).

canMovePerpetually

public boolean canMovePerpetually()

Description copied from interface: IStructureConst

Checks if this structure can move perpetually.

Specified by:

canMovePerpetually in interface IStructureConst

Returns:

True if this structure can move perpetually.

getOwners

public Collection<StructureOwner> getOwners()

Description copied from interface: IStructureConst

Gets all StructureOwners of this structure, including the original creator.

Specified by:

getOwners in interface IStructureConst

Returns:

All StructureOwners of this structure, including the original creator.

getSnapshot

public StructureSnapshot getSnapshot()

Description copied from interface: IStructureConst

Returns a (read-only) StructureSnapshot of this structure.

Repeated calls to this method may or may not return the same instance unless the underlying structure has been modified, in which case a new snapshot reflecting the changes will be returned.

Specified by:

getSnapshot in interface IStructureConst

Returns:

A StructureSnapshot of this structure.

getUid

public long getUid()

Description copied from interface: IStructureConst

Gets the UID of the Structure as used in the database. Guaranteed to be unique and available.

Specified by:

getUid in interface IStructureConst

Returns:

The UID of the Structure as used in the database.

getWorld

public IWorld getWorld()

Description copied from interface: IStructureConst

Gets the IWorld this Structure exists in.

Specified by:

getWorld in interface IStructureConst

Returns:

The IWorld this Structure exists in

getAnimationRange

public Rectangle getAnimationRange()

Description copied from interface: IStructureConst

Gets the rectangle describing the limits within an animation of this door takes place.

At no point during an animation will any animated block leave this cuboid, though not guarantees are given regarding how tight the cuboid fits around the animated blocks.

Specified by:

getAnimationRange in interface IStructureConst

Returns:

The animation range.

getPowerBlock

public Vector3Di getPowerBlock()

Description copied from interface: IStructureConst

Gets the position of power block of this structure.

Specified by:

getPowerBlock in interface IStructureConst

Returns:

The position of the power block of this structure.

getName

public String getName()

Description copied from interface: IStructureConst

Gets the name of this structure.

Specified by:

getName in interface IStructureConst

Returns:

The name of this structure.

getCuboid

public Cuboid getCuboid()

Description copied from interface: IStructureConst

Gets the Cuboid representing the area taken up by this structure.

Specified by:

getCuboid in interface IStructureConst

Returns:

The Cuboid representing the area taken up by this structure.

getOpenDirection

public MovementDirection getOpenDirection()

Description copied from interface: IStructureConst

Gets the MovementDirection this Structure will open if currently closed.

Note that if it's currently in the open status, it is supposed go in the opposite direction, as the closing direction is the opposite of the opening direction. This isn't taken into account by this method.

Specified by:

getOpenDirection in interface IStructureConst

Returns:

The MovementDirection this Structure will open in.

isLocked

public boolean isLocked()

Description copied from interface: IStructureConst

Check if the Structure is currently locked. When locked, structures cannot be opened.

Specified by:

isLocked in interface IStructureConst

Returns:

True if the Structure is locked

getPrimeOwner

public StructureOwner getPrimeOwner()

Description copied from interface: IStructureConst

Gets the prime owner (permission = 0) of this structure. In most cases, this will be the original creator of the structure.

Specified by:

getPrimeOwner in interface IStructureConst

Returns:

The prime owner of this structure.

getOwnersMap

public Map<UUID, StructureOwner> getOwnersMap()

getType

public StructureType getType()

Description copied from interface: IStructureConst

Returns the StructureType of this structure.

Specified by:

getType in interface IStructureConst

Returns:

The StructureType of this structure.

getCycledOpenDirection

public MovementDirection getCycledOpenDirection()

Description copied from interface: IStructureConst

Cycle the MovementDirection direction this Structure will open in. By default, it will loop over all valid directions. See StructureType.getValidOpenDirectionsList(). However, subclasses may override this behavior.

Note that this does not actually change the open direction; it merely tells you which direction comes next!

Specified by:

getCycledOpenDirection in interface IStructureConst

Returns:

The new MovementDirection direction this Structure will open in.

getMinimumAnimationTime

public double getMinimumAnimationTime()

Description copied from interface: IStructureConst

Gets the lower time limit for an animation.

Because animated blocks have a speed limit, as determined by IConfig.maxBlockSpeed(), there is also a minimum amount of time for its animation.

The exact time limit depends on the shape, size, and type of structure.

Specified by:

getMinimumAnimationTime in interface IStructureConst

Returns:

The lower animation time limit for this structure in seconds.

isCanMovePerpetually

public boolean isCanMovePerpetually()

toString

public @NonNull String toString()

Overrides:

toString in class Object

getPropertyContainerSnapshot

public IPropertyContainerConst getPropertyContainerSnapshot()

Description copied from interface: IStructureConst

Gets the PropertyContainerSnapshot of this structure.

Specified by:

getPropertyContainerSnapshot in interface IStructureConst

Returns:

The PropertyContainerSnapshot of this structure.

iterator

public Iterator<PropertyValuePair<?>> iterator()

spliterator

public Spliterator<PropertyValuePair<?>> spliterator()

stream

public Stream<PropertyValuePair<?>> stream()

getPropertyValue

public <T> IPropertyValue<T> getPropertyValue(Property<T> property)

Description copied from interface: IPropertyHolderConst

Gets the value of the given property.

Specified by:

getPropertyValue in interface IPropertyHolderConst

Type Parameters:

T - The type of the property.

Parameters:

property - The property to get the value of.

Returns:

The value of the property.

getRequiredPropertyValue

public <T> T getRequiredPropertyValue(Property<T> property)

Description copied from interface: IPropertyHolderConst

Gets the value of a required property.

If the property has no value set or the value is null, a NullPointerException is thrown.

Specified by:

getRequiredPropertyValue in interface IPropertyHolderConst

Type Parameters:

T - The type of the property.

Parameters:

property - The property to get the value of.

Returns:

The raw value of the property.

hasProperty

public boolean hasProperty(Property<?> property)

Description copied from interface: IPropertyHolderConst

Checks if the given property has a value set.

Specified by:

hasProperty in interface IPropertyHolderConst

Parameters:

property - The property to check.

Returns:

true if the property has a value set, false otherwise.

hasProperties

public boolean hasProperties(Property<?>... properties)

Description copied from interface: IPropertyHolderConst

Checks if this property holder has all the given properties.

Specified by:

hasProperties in interface IPropertyHolderConst

Parameters:

properties - The properties to check.

Returns:

true if this property holder has all the given properties, false otherwise.

hasProperties

public boolean hasProperties(SequencedCollection<Property<?>> properties)

Description copied from interface: IPropertyHolderConst

Checks if this property holder has all the given properties.

Specified by:

hasProperties in interface IPropertyHolderConst

Parameters:

properties - The properties to check.

Returns:

true if this property holder has all the given properties, false otherwise.

hasProperties

public boolean hasProperties(Collection<Property<?>> properties)

Description copied from interface: IPropertyHolderConst

Checks if this property holder has all the given properties.

Specified by:

hasProperties in interface IPropertyHolderConst

Parameters:

properties - The properties to check.

Returns:

true if this property holder has all the given properties, false otherwise.

propertyCount

public int propertyCount()

Description copied from interface: IPropertyHolderConst

Gets the number of properties in this property container.

This is the number of entries in the property map.

Specified by:

propertyCount in interface IPropertyHolderConst

Returns:

The number of properties in this property container.

forEach

public void forEach(Consumer<? super PropertyValuePair<?>> action)