Module nl.crashdata.chartjs.data

Package nl.crashdata.chartjs.data.simple.builder

Class SimpleChartJsTimeConfigBuilder

java.lang.Object

nl.crashdata.chartjs.data.simple.builder.SimpleChartJsTimeConfigBuilder

All Implemented Interfaces:

SimpleChartJsBuilder<ChartJsTimeConfig>

public class SimpleChartJsTimeConfigBuilder
extends Object
implements SimpleChartJsBuilder<ChartJsTimeConfig>

Constructor Summary

Constructors

Constructor	Description
SimpleChartJsTimeConfigBuilder()

Method Summary

Modifier and Type	Method	Description
ChartJsTimeConfig	build()	Builds a valid C such that builder.build() != builder.build().
boolean	isValid()	Returns true if the state of this builder, including all its delegate builders, is ready to build.
SimpleChartJsTimeConfigBuilder	withIsoWeekday(Boolean isoWeekday)
SimpleChartJsTimeConfigBuilder	withMinimumDisplayUnit(ChartJsTimeUnit minimumDisplayUnit)
SimpleChartJsTimeConfigBuilder	withStepSize(Number stepSize)
SimpleChartJsTimeConfigBuilder	withTimeUnit(ChartJsTimeUnit timeUnit)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleChartJsTimeConfigBuilder

public SimpleChartJsTimeConfigBuilder()

Method Detail

withIsoWeekday

public SimpleChartJsTimeConfigBuilder withIsoWeekday(Boolean isoWeekday)

Parameters:

isoWeekday - if true, the week starts on Monday, otherwise it starts on Sunday. Only relevant if withTimeUnit(ChartJsTimeUnit) is set to ChartJsTimeUnit.WEEK

withStepSize

public SimpleChartJsTimeConfigBuilder withStepSize(Number stepSize)

withTimeUnit

public SimpleChartJsTimeConfigBuilder withTimeUnit(ChartJsTimeUnit timeUnit)

withMinimumDisplayUnit

public SimpleChartJsTimeConfigBuilder withMinimumDisplayUnit(ChartJsTimeUnit minimumDisplayUnit)

isValid

public boolean isValid()

Description copied from interface: SimpleChartJsBuilder

Returns true if the state of this builder, including all its delegate builders, is ready to build. "Ready to build" means that this builder, including all its delegate builders, is in such a state that SimpleChartJsBuilder.build() would return a viable SimpleChartJs configuration object.

Specified by:

isValid in interface SimpleChartJsBuilder<ChartJsTimeConfig>

build

public ChartJsTimeConfig build()
                        throws IllegalStateException

Description copied from interface: SimpleChartJsBuilder

Builds a valid C such that builder.build() != builder.build().

Specified by:

build in interface SimpleChartJsBuilder<ChartJsTimeConfig>

Returns:

a valid C if and only if SimpleChartJsBuilder.isValid() returns true.

Throws:

IllegalStateException - if called when SimpleChartJsBuilder.isValid() returns false