Package org.gedcomx.date

Class GedcomxDateRecurring

java.lang.Object
org.gedcomx.date.GedcomxDate
org.gedcomx.date.GedcomxDateRecurring
All Implemented Interfaces:
Comparable<GedcomxDate>
public class GedcomxDateRecurring extends GedcomxDate
A Recurring Date
Author:
John Clark.

  • Constructor Details

    • GedcomxDateRecurring

      public GedcomxDateRecurring(String date)
      Instantiate a new Recurring date from the formal date string
      Parameters:
      date - The formal date string

  • Method Details

    • getCount

      public Integer getCount()
      Get the count
      Returns:
      The Count

    • getRange

      public GedcomxDateRange getRange()
      Get the range
      Returns:
      The Range

    • getStart

      public GedcomxDateSimple getStart()
      Get the start date
      Returns:
      The Start Date

    • getDuration

      public GedcomxDateDuration getDuration()
      Get the duration
      Returns:
      The Duration

    • getEnd

      public GedcomxDateSimple getEnd()
      Get the end date
      Returns:
      The End Date

    • getNth

      public GedcomxDateSimple getNth(Integer count)
      Get the nth instance of this recurring date
      Parameters:
      count - The nth instance
      Returns:
      The date of the nth instance

    • getType

      public GedcomxDateType getType()
      Get the date type
      Specified by:
      getType in class GedcomxDate
      Returns:
      The Date Type

    • isApproximate

      public boolean isApproximate()
      Whether or not this date is considered approximate
      Specified by:
      isApproximate in class GedcomxDate
      Returns:
      True if this date is approximate

    • toFormalString

      public String toFormalString()
      Return the formal string for this date
      Specified by:
      toFormalString in class GedcomxDate
      Returns:
      The formal date string