Interface TimelineReference

All Known Implementing Classes:

TimelineReference.Id, TimelineReference.Tag

public sealed interface TimelineReference
permits TimelineReference.Id, TimelineReference.Tag

A reference to a single object specified by DimensionTypeDefinition.timelines() It can be either a single timeline or a tag grouping several.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	TimelineReference.Id
static final record	TimelineReference.Tag

Method Summary

Static Methods

Modifier and Type	Method	Description
static TimelineReference	id(TypedKey<Timeline> key)
static TimelineReference	tag(TagKey<Timeline> key)

Method Details

id

@Contract(value="_ -> new",
          pure=true)
static TimelineReference id(TypedKey<Timeline> key)

Parameters:

key - the timeline's namespaced identifier

Returns:

the reference

tag

@Contract(value="_ -> new",
          pure=true)
static TimelineReference tag(TagKey<Timeline> key)

Parameters:

key - the tag's namespaced identifier, without the leading #

Returns:

the reference