Class YearMonthDateParameterMetadata

    • Method Detail

      • of

        public static YearMonthDateParameterMetadata of​(LocalDate date,
                                                        YearMonth yearMonth)
        Obtains an instance using the year-month.
        Parameters:
        date - the date associated with the parameter
        yearMonth - the year-month of the curve node
        Returns:
        the parameter metadata based on the year-month
      • of

        public static YearMonthDateParameterMetadata of​(LocalDate date,
                                                        YearMonth yearMonth,
                                                        String label)
        Obtains an instance using the year-month, specifying the label.
        Parameters:
        date - the date associated with the parameter
        yearMonth - the year-month of the curve node
        label - the label to use
        Returns:
        the parameter metadata based on the year-month
      • getDate

        public LocalDate getDate()
        Gets the date associated with the parameter.

        This is the date that is most closely associated with the parameter. The actual parameter is typically a year fraction based on a day count.

        Specified by:
        getDate in interface DatedParameterMetadata
        Returns:
        the value of the property, not null
      • getYearMonth

        public YearMonth getYearMonth()
        Gets the year-month associated with the parameter.
        Returns:
        the value of the property, not null
      • getLabel

        public String getLabel()
        Gets the label that describes the parameter, defaulted to the year-month.
        Specified by:
        getLabel in interface ParameterMetadata
        Returns:
        the value of the property, not empty
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object