io.coinapi.rest

Class Period

java.lang.Object

io.coinapi.rest.Period

public class Period
extends Object

Stores all the state for a period, as described in https://docs.coinapi.io/#list-all-periods.

This class is multithread safe: it is immutable. In particular, it is always properly constructed, all of its fields are final, and none of their state can be changed after construction. See p. 53 of Java Concurrency In Practice for more discussion.

Constructor Summary

Constructors

Constructor and Description
Period(io.coinapi.rest.Period_identifier period_id, int length_seconds, int length_months, int unit_count, String unit_name, String display_name)

Method Summary

Modifier and Type	Method and Description
String	get_display_name()
int	get_length_months()
int	get_length_seconds()
io.coinapi.rest.Period_identifier	get_period_id()
int	get_unit_count()
String	get_unit_name()

Methods inherited from class java.lang.Object

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

Constructor Detail

Period

public Period(io.coinapi.rest.Period_identifier period_id,
              int length_seconds,
              int length_months,
              int unit_count,
              String unit_name,
              String display_name)

Method Detail

get_period_id

public io.coinapi.rest.Period_identifier get_period_id()

get_length_seconds

public int get_length_seconds()

get_length_months

public int get_length_months()

get_unit_count

public int get_unit_count()

get_unit_name

public String get_unit_name()

get_display_name

public String get_display_name()