Package de.espirit.firstspirit.client.plugin.timeline

Class TimelineEntry.Factory

java.lang.Object

de.espirit.firstspirit.client.plugin.timeline.TimelineEntry.Factory

Enclosing interface:

TimelineEntry

public static class TimelineEntry.Factory
extends Object

Factory for creation of TimelineEntry.

Since:

5.1.107

Constructor Summary

Constructors

Constructor	Description
Factory()

Method Summary

Modifier and Type	Method	Description
static @NotNull TimelineEntry.Factory	builder()	Creates an instance of this factory for creation of TimelineEntry using a builder pattern.
@NotNull TimelineEntry	create()	Creates a TimelineEntry based on the given settings.
static @NotNull TimelineEntry	create(@NotNull Revision revision)	Creates a TimelineEntry associated with the specified revision.
static @NotNull TimelineEntry	create(@NotNull Date timestamp)	Creates a TimelineEntry associated with the specified timestamp.
@NotNull TimelineEntry.Factory	revision(Revision revision)	Sets the revision, the resulting TimelineEntry should be associated with.
@NotNull TimelineEntry.Factory	timestamp(Date timestamp)	Sets the timestamp, the resulting TimelineEntry should be associated with.

Methods inherited from class java.lang.Object

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

Constructor Details

Factory

public Factory()

Method Details

builder

@NotNull
public static @NotNull TimelineEntry.Factory builder()

Creates an instance of this factory for creation of TimelineEntry using a builder pattern.

Returns:

builder

Since:

5.1.107

create

@NotNull
public static @NotNull TimelineEntry create(@NotNull
 @NotNull Date timestamp)

Creates a TimelineEntry associated with the specified timestamp.

Returns:

timeline entry

Since:

5.1.107

create

@NotNull
public static @NotNull TimelineEntry create(@NotNull
 @NotNull Revision revision)

Creates a TimelineEntry associated with the specified revision.

Returns:

timeline entry

Since:

5.1.107

timestamp

@NotNull
public @NotNull TimelineEntry.Factory timestamp(Date timestamp)

Sets the timestamp, the resulting TimelineEntry should be associated with. If revision(Revision) is used, Revision.getCommitOrCreationTime() will be used as timestamp.

Returns:

this builder

Since:

5.1.107

revision

@NotNull
public @NotNull TimelineEntry.Factory revision(Revision revision)

Sets the revision, the resulting TimelineEntry should be associated with. Revision.getCommitOrCreationTime() will be used as timestamp.

Returns:

this builder

Since:

5.1.107

create

@NotNull
public @NotNull TimelineEntry create()

Creates a TimelineEntry based on the given settings.

Returns:

a new TimelineEntry instance

Throws:

IllegalStateException - if revision or timestamp is missing

Since:

5.1.107