Package com.inductiveautomation.historian.common.model.data

Class AnnotationPoint.Builder

java.lang.Object

com.inductiveautomation.historian.common.model.data.AnnotationPoint.Builder

Enclosing class:

AnnotationPoint

public static class AnnotationPoint.Builder
extends Object

A builder class for constructing AnnotationPoint instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AnnotationPoint.Builder	annotationType(String annotationType)	Sets the annotation type.
AnnotationPoint.Builder	author(String author)	Sets the author of the annotation.
AnnotationPoint	build()	Builds a new AnnotationPoint instance.
AnnotationPoint.Builder	endTime(@Nullable Instant endTime)	Sets the end time of the annotation.
AnnotationPoint.Builder	identifier(String identifier)	Sets the identifier of the annotation from a string representation.
AnnotationPoint.Builder	identifier(UUID identifier)	Sets the identifier of the annotation.
AnnotationPoint.Builder	lastUpdated(@Nullable Instant lastUpdated)	Sets the last updated time of the annotation.
AnnotationPoint.Builder	notes(String notes)	Sets the notes for the annotation.
AnnotationPoint.Builder	source(QualifiedPath source)	Sets the source of the annotation.
AnnotationPoint.Builder	startTime(Instant startTime)	Sets the start time of the annotation.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

notes

public AnnotationPoint.Builder notes(String notes)

Sets the notes for the annotation.

Parameters:

notes - The notes to set.

Returns:

The current AnnotationPoint.Builder instance.

annotationType

public AnnotationPoint.Builder annotationType(String annotationType)

Sets the annotation type.

Parameters:

annotationType - The annotation type to set.

Returns:

The current AnnotationPoint.Builder instance.

author

public AnnotationPoint.Builder author(String author)

Sets the author of the annotation.

Parameters:

author - The author to set.

Returns:

The current AnnotationPoint.Builder instance.

startTime

public AnnotationPoint.Builder startTime(Instant startTime)

Sets the start time of the annotation.

Parameters:

startTime - The Instant start time to set.

Returns:

The current AnnotationPoint.Builder instance.

endTime

public AnnotationPoint.Builder endTime(@Nullable
 @Nullable Instant endTime)

Sets the end time of the annotation.

Parameters:

endTime - The Instant end time to set, or null if not applicable.

Returns:

The current AnnotationPoint.Builder instance.

source

public AnnotationPoint.Builder source(QualifiedPath source)

Sets the source of the annotation.

Parameters:

source - The QualifiedPath source to set.

Returns:

The current AnnotationPoint.Builder instance.

identifier

public AnnotationPoint.Builder identifier(UUID identifier)

Sets the identifier of the annotation.

Parameters:

identifier - The UUID identifier to set.

Returns:

The current AnnotationPoint.Builder instance.

identifier

public AnnotationPoint.Builder identifier(String identifier)

Sets the identifier of the annotation from a string representation.

Parameters:

identifier - The string representation of the UUID identifier to set.

Returns:

The current AnnotationPoint.Builder instance.

Throws:

IllegalArgumentException - If the string is not a valid UUID.

lastUpdated

public AnnotationPoint.Builder lastUpdated(@Nullable
 @Nullable Instant lastUpdated)

Sets the last updated time of the annotation.

Parameters:

lastUpdated - The Instant last updated time to set, or null if not applicable.

Returns:

The current AnnotationPoint.Builder instance.

build

public AnnotationPoint build()

Builds a new AnnotationPoint instance.

Returns:

A new AnnotationPoint.

Throws:

NullPointerException - If any required field is null.