org.rvpf.base

Interface Points

All Known Implementing Classes:

Metadata, Points.Impl

public interface Points

Points.

This interface provides access to the point definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Points.Impl Impl.

Method Summary

Modifier and Type	Method and Description
Optional<Point>	getPoint(String key) Gets the point with the specified key.
Optional<Point>	getPointByName(String name) Gets the point with the specified name.
Optional<Point>	getPointByUUID(UUID uuid) Gets the point with the specified UUID.
Collection<Point>	getPointsCollection() Gets a collection of the registered points.

Method Detail

getPoint

@Nonnull
 @CheckReturnValue
Optional<Point> getPoint(@Nonnull
                                                       String key)

Gets the point with the specified key.

Parameters:

key - The key (either UUID string or name).

Returns:

The optional point.

getPointByName

@Nonnull
 @CheckReturnValue
Optional<Point> getPointByName(@Nonnull
                                                             String name)

Gets the point with the specified name.

Parameters:

name - The name.

Returns:

The optional point.

getPointByUUID

@Nonnull
 @CheckReturnValue
Optional<Point> getPointByUUID(@Nonnull
                                                             UUID uuid)

Gets the point with the specified UUID.

Parameters:

uuid - The UUID.

Returns:

The optional point.

getPointsCollection

@Nonnull
 @CheckReturnValue
Collection<Point> getPointsCollection()

Gets a collection of the registered points.

Returns:

A collection of points.