Module io.xpipe.core

Package io.xpipe.core.source

Interface DataSourceReference

All Known Implementing Classes:

DataSourceReference.Id, DataSourceReference.Latest, DataSourceReference.Name

public interface DataSourceReference

Represents a reference to an X-Pipe data source. Using DataSourceReference instances instead of DataSourceId instances is mainly done for user convenience purposes.

While a DataSourceId represents a unique and canonical identifier for an X-Pipe data source, there also exist easier and shorter ways to address a data source. This convenience comes at the price of ambiguity and instability for other types of references.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataSourceReference.Id	A wrapper class for DataSourceId instances.
static class	DataSourceReference.Latest	Specifying the latest reference allows the user to always address the latest data source.
static class	DataSourceReference.Name	Using only the data source name allows for a shorthand way of referring to data sources.
static enum	DataSourceReference.Type

Method Summary

Modifier and Type	Method	Description
DataSourceId	getId()
String	getName()
DataSourceReference.Type	getType()
static DataSourceReference	id(DataSourceId id)	Creates a reference by using a canonical data source id.
static DataSourceReference	id(String id)	Convenience method for id(DataSourceId)
static DataSourceReference	latest()	Creates a reference that always refers to the latest data source.
static DataSourceReference	name(String name)	Creates a reference using only the data source name.
static DataSourceReference	parse(String s)
String	toRefString()	Returns the internal string representation of this reference.
String	toString()

Method Details

latest

static DataSourceReference latest()

Creates a reference that always refers to the latest data source.

See Also:

• DataSourceReference.Latest

name

static DataSourceReference name(String name)

Creates a reference using only the data source name.

See Also:

• DataSourceReference.Name

id

static DataSourceReference id(String id)

Convenience method for id(DataSourceId)

See Also:

• DataSourceId.fromString(String)

id

static DataSourceReference id(DataSourceId id)

Creates a reference by using a canonical data source id.

See Also:

• DataSourceReference.Id

parse

static DataSourceReference parse(String s)

getType

DataSourceReference.Type getType()

getId

DataSourceId getId()

getName

String getName()

toRefString

String toRefString()

Returns the internal string representation of this reference.

toString

String toString()

Overrides:

toString in class Object