Class TemporalExpressions.Substitution

    • Method Detail

      • first

        public com.ibm.icu.util.Calendar first​(com.ibm.icu.util.Calendar cal)
        Description copied from class: TemporalExpression
        Returns a date representing the first occurrence of this expression on or after a specified date. Returns null if there is no matching date.
        Specified by:
        first in class TemporalExpression
        Parameters:
        cal - A date to evaluate
        Returns:
        A Calendar instance representing the first matching date, or null if no matching date is found
      • getExcluded

        public TemporalExpression getExcluded()
        Returns the excluded expression.
        Returns:
        The excluded TemporalExpression
      • getIncluded

        public TemporalExpression getIncluded()
        Returns the included expression.
        Returns:
        The included TemporalExpression
      • getSubstitute

        public TemporalExpression getSubstitute()
        Returns the substitute expression.
        Returns:
        The substitute TemporalExpression
      • includesDate

        public boolean includesDate​(com.ibm.icu.util.Calendar cal)
        Description copied from class: TemporalExpression
        Returns true if this expression includes the specified date.
        Specified by:
        includesDate in class TemporalExpression
        Parameters:
        cal - A date to evaluate
        Returns:
        true if this expression includes the date represented by cal
      • isSubstitutionCandidate

        public boolean isSubstitutionCandidate​(com.ibm.icu.util.Calendar cal,
                                               TemporalExpression expressionToTest)
        Description copied from class: TemporalExpression
        Returns true if this expression is a candidate for substitution using the expression expressionToTest for the date cal. A Substitution object will call this method when it needs to know if this expression could have produced the date cal based on the expression expressionToTest.
        Specified by:
        isSubstitutionCandidate in class TemporalExpression
        Parameters:
        cal - A date to evaluate
        expressionToTest - An expression to evaluate
        Returns:
        true if this expression could have produced the date cal using the expression expressionToTest