Class Calendars


  • public final class Calendars
    extends Object
    $Id$ Created on 10/11/2006 Utility method for working with Calendars.
    • Method Detail

      • load

        public static Calendar load​(String filename)
                             throws IOException,
                                    ParserException
        Loads a calendar from the specified file.
        Parameters:
        filename - the name of the file from which to load calendar data
        Returns:
        returns a new calendar instance initialised from the specified file
        Throws:
        IOException - occurs when there is an error reading the specified file
        ParserException - occurs when the data in the specified file is invalid
      • load

        public static Calendar load​(URL url)
                             throws IOException,
                                    ParserException
        Loads a calendar from the specified URL.
        Parameters:
        url - the URL from which to load calendar data
        Returns:
        returns a new calendar instance initialised from the specified URL
        Throws:
        IOException - occurs when there is an error reading from the specified URL
        ParserException - occurs when the data in the specified URL is invalid
      • merge

        public static Calendar merge​(Calendar c1,
                                     Calendar c2)
        Merge all properties and components from two specified calendars into one instance. Note that the merge process is not very sophisticated, and may result in invalid calendar data (e.g. multiple properties of a type that should only be specified once).
        Parameters:
        c1 - the first calendar to merge
        c2 - the second calendar to merge
        Returns:
        a Calendar instance containing all properties and components from both of the specified calendars
      • wrap

        public static Calendar wrap​(CalendarComponent... component)
        Wraps a component in a calendar.
        Parameters:
        component - the component to wrap with a calendar
        Returns:
        a calendar containing the specified component
      • split

        public static Calendar[] split​(Calendar calendar)
        Splits a calendar object into distinct calendar objects for unique identifers (UID).
        Parameters:
        calendar - a calendar instance
        Returns:
        an array of calendar objects
      • getUid

        public static Uid getUid​(Calendar calendar)
                          throws ConstraintViolationException
        Returns a unique identifier as specified by components in the provided calendar.
        Parameters:
        calendar - a calendar instance
        Returns:
        the UID property
        Throws:
        ConstraintViolationException - if zero or more than one unique identifer is found in the specified calendar
      • getContentType

        public static String getContentType​(Calendar calendar,
                                            Charset charset)
        Returns an appropriate MIME Content-Type for the specified calendar object.
        Parameters:
        calendar - a calendar instance
        charset - an optional encoding
        Returns:
        a content type string