Class ImmutablePriceIndex.Builder

  • All Implemented Interfaces:
    org.joda.beans.BeanBuilder<ImmutablePriceIndex>
    Enclosing class:
    ImmutablePriceIndex

    public static final class ImmutablePriceIndex.Builder
    extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ImmutablePriceIndex>
    The bean-builder for ImmutablePriceIndex.
    • Method Detail

      • name

        public ImmutablePriceIndex.Builder name​(String name)
        Sets the index name, such as 'GB-HICP'.
        Parameters:
        name - the new value, not null
        Returns:
        this, for chaining, not null
      • region

        public ImmutablePriceIndex.Builder region​(Country region)
        Sets the region of the index.
        Parameters:
        region - the new value, not null
        Returns:
        this, for chaining, not null
      • currency

        public ImmutablePriceIndex.Builder currency​(Currency currency)
        Sets the currency of the index.
        Parameters:
        currency - the new value, not null
        Returns:
        this, for chaining, not null
      • active

        public ImmutablePriceIndex.Builder active​(boolean active)
        Sets whether the index is active, defaulted to true.

        Over time some indices become inactive and are no longer produced. If this occurs, this flag will be set to false.

        Parameters:
        active - the new value
        Returns:
        this, for chaining, not null
      • publicationFrequency

        public ImmutablePriceIndex.Builder publicationFrequency​(Frequency publicationFrequency)
        Sets the publication frequency of the index. Most price indices are published monthly, but some are published quarterly.
        Parameters:
        publicationFrequency - the new value, not null
        Returns:
        this, for chaining, not null
      • toString

        public String toString()
        Overrides:
        toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ImmutablePriceIndex>