server/io.spine.server.entity/EntityVisibility

EntityVisibility

public final class EntityVisibility implements Serializable

The visibility of an entity type.

An entity can have one of the following visibility levels:

NONE - the entity is not visible to the clients for reading;
QUERY - the entity is visible for querying, but not for subscription;
SUBSCRIBE - the entity is visible for subscription, but not for querying;
FULL - the entity is visible for both subscription and querying.

The visibility of an entity is defined by the (entity) option. By default, any entity is has the NONE level except for projections, which have the FULL level.

Functions

canQuery

public boolean canQuery()

Checks if the visibility level is sufficient for querying.

canSubscribe

public boolean canSubscribe()

Checks if the visibility level is sufficient for subscription.

public boolean is(Visibility visibility)

Checks if the visibility is exactly of the given level.

isAsLeast

public boolean isAsLeast(Visibility visibility)

Checks if the visibility is at least as allowing as the given one.

isNotNone

public boolean isNotNone()

Checks if the visibility level is not NONE.

public static Optional<EntityVisibility> of(Class<? extends EntityState> stateClass)

Obtains an instance of EntityVisibility for the given entity state class.

toString

public String toString()