Package pl.poznan.put.circular.samples

Class ImmutableTrigonometricMoment.Builder

java.lang.Object
pl.poznan.put.circular.samples.ImmutableTrigonometricMoment.Builder
Enclosing class:
ImmutableTrigonometricMoment
@NotThreadSafe public static final class ImmutableTrigonometricMoment.Builder extends Object
Builds instances of type ImmutableTrigonometricMoment. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • from

      public final ImmutableTrigonometricMoment.Builder from(TrigonometricMoment instance)
      Fill a builder with attribute values from the provided TrigonometricMoment instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • meanDirection

      public final ImmutableTrigonometricMoment.Builder meanDirection(Angle meanDirection)
      Initializes the value for the meanDirection attribute.
      Parameters:
      meanDirection - The value for meanDirection
      Returns:
      this builder for use in a chained invocation

    • meanResultantLength

      public final ImmutableTrigonometricMoment.Builder meanResultantLength(double meanResultantLength)
      Initializes the value for the meanResultantLength attribute.
      Parameters:
      meanResultantLength - The value for meanResultantLength
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableTrigonometricMoment build()
      Builds a new ImmutableTrigonometricMoment.
      Returns:
      An immutable instance of TrigonometricMoment
      Throws:
      IllegalStateException - if any required attributes are missing