Class GregorianCalendar

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.Calendar>, SCO<java.util.GregorianCalendar>

    public class GregorianCalendar
    extends java.util.GregorianCalendar
    implements SCO<java.util.GregorianCalendar>
    A mutable second-class GregorianCalendar object.
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.Calendar

        java.util.Calendar.Builder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected AbstractMemberMetaData ownerMmd  
      protected DNStateManager ownerSM  
      • Fields inherited from class java.util.GregorianCalendar

        AD, BC
      • Fields inherited from class java.util.Calendar

        ALL_STYLES, AM, AM_PM, APRIL, areFieldsSet, AUGUST, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DST_OFFSET, ERA, FEBRUARY, FIELD_COUNT, fields, FRIDAY, HOUR, HOUR_OF_DAY, isSet, isTimeSet, JANUARY, JULY, JUNE, LONG, LONG_FORMAT, LONG_STANDALONE, MARCH, MAY, MILLISECOND, MINUTE, MONDAY, MONTH, NARROW_FORMAT, NARROW_STANDALONE, NOVEMBER, OCTOBER, PM, SATURDAY, SECOND, SEPTEMBER, SHORT, SHORT_FORMAT, SHORT_STANDALONE, SUNDAY, THURSDAY, time, TUESDAY, UNDECIMBER, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, YEAR, ZONE_OFFSET
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(int field, int amount)
      Method to add an amount to a field
      void attachCopy​(java.util.GregorianCalendar value)
      Method to return an attached version for the passed StateManager and field, using the passed value.
      java.lang.Object clone()
      Creates and returns a copy of this object.
      java.util.GregorianCalendar detachCopy​(FetchPlanState state)
      Method to return a detached copy of the value object.
      java.lang.String getFieldName()
      Accessor for the field name
      java.lang.Object getOwner()
      Accessor for the owner.
      java.util.GregorianCalendar getValue()
      Accessor for the unwrapped value that we are wrapping.
      void initialise()
      Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store).
      void initialise​(java.util.GregorianCalendar cal)
      Method to initialise the SCO for use with the provided initial value.
      void initialise​(java.util.GregorianCalendar newValue, java.lang.Object oldValue)
      Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value.
      void makeDirty()
      Utility to mark the object as dirty
      void roll​(int field, boolean up)
      Method to roll a field by 1.
      void roll​(int field, int amount)
      Method to roll the value of a field
      void set​(int field, int value)
      Method to set a field
      void setFirstDayOfWeek​(int value)
      Method to set the first day of the week
      void setGregorianChange​(java.util.Date date)
      Method to set the gregorian cal change date
      void setLenient​(boolean lenient)
      Method to set the lenient setting
      void setMinimalDaysInFirstWeek​(int value)
      Method to set the minimal days in the week
      void setTimeInMillis​(long millis)
      Method to set the time in milliseconds
      void setTimeZone​(java.util.TimeZone value)
      Method to set the timezone
      void unsetOwner()
      Utility to unset the owner.
      protected java.lang.Object writeReplace()
      The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.
      • Methods inherited from class java.util.GregorianCalendar

        computeFields, computeTime, equals, from, getActualMaximum, getActualMinimum, getCalendarType, getGreatestMinimum, getGregorianChange, getLeastMaximum, getMaximum, getMinimum, getTimeZone, getWeeksInWeekYear, getWeekYear, hashCode, isLeapYear, isWeekDateSupported, setWeekDate, toZonedDateTime
      • Methods inherited from class java.util.Calendar

        after, before, clear, clear, compareTo, complete, get, getAvailableCalendarTypes, getAvailableLocales, getDisplayName, getDisplayNames, getFirstDayOfWeek, getInstance, getInstance, getInstance, getInstance, getMinimalDaysInFirstWeek, getTime, getTimeInMillis, internalGet, isLenient, isSet, set, set, set, setTime, toInstant, toString
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • GregorianCalendar

        public GregorianCalendar​(DNStateManager sm,
                                 AbstractMemberMetaData mmd)
        Creates a GregorianCalendar object that represents the time at which it was allocated. Assigns owning object and field name.
        Parameters:
        sm - StateManager for the owning object
        mmd - Metadata for the member
    • Method Detail

      • initialise

        public void initialise()
        Description copied from interface: SCO
        Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.
        Specified by:
        initialise in interface SCO<java.util.GregorianCalendar>
      • initialise

        public void initialise​(java.util.GregorianCalendar newValue,
                               java.lang.Object oldValue)
        Description copied from interface: SCO
        Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).
        Specified by:
        initialise in interface SCO<java.util.GregorianCalendar>
        Parameters:
        newValue - New value (to wrap)
        oldValue - Old value (to use in deciding what needs deleting etc)
      • initialise

        public void initialise​(java.util.GregorianCalendar cal)
        Description copied from interface: SCO
        Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.
        Specified by:
        initialise in interface SCO<java.util.GregorianCalendar>
        Parameters:
        cal - the object from which to copy the value.
      • getValue

        public java.util.GregorianCalendar getValue()
        Accessor for the unwrapped value that we are wrapping.
        Specified by:
        getValue in interface SCO<java.util.GregorianCalendar>
        Returns:
        The unwrapped value
      • unsetOwner

        public void unsetOwner()
        Utility to unset the owner.
        Specified by:
        unsetOwner in interface SCO<java.util.GregorianCalendar>
      • getOwner

        public java.lang.Object getOwner()
        Accessor for the owner.
        Specified by:
        getOwner in interface SCO<java.util.GregorianCalendar>
        Returns:
        The owner
      • getFieldName

        public java.lang.String getFieldName()
        Accessor for the field name
        Specified by:
        getFieldName in interface SCO<java.util.GregorianCalendar>
        Returns:
        The field name
      • makeDirty

        public void makeDirty()
        Utility to mark the object as dirty
      • detachCopy

        public java.util.GregorianCalendar detachCopy​(FetchPlanState state)
        Method to return a detached copy of the value object.
        Specified by:
        detachCopy in interface SCO<java.util.GregorianCalendar>
        Parameters:
        state - State for detachment process
        Returns:
        The detached copy
      • attachCopy

        public void attachCopy​(java.util.GregorianCalendar value)
        Method to return an attached version for the passed StateManager and field, using the passed value.
        Specified by:
        attachCopy in interface SCO<java.util.GregorianCalendar>
        Parameters:
        value - The new value
      • clone

        public java.lang.Object clone()
        Creates and returns a copy of this object.

        Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

        Specified by:
        clone in interface SCO<java.util.GregorianCalendar>
        Overrides:
        clone in class java.util.GregorianCalendar
        Returns:
        A clone of the object
      • writeReplace

        protected java.lang.Object writeReplace()
                                         throws java.io.ObjectStreamException
        The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.
        Returns:
        the replaced object
        Throws:
        java.io.ObjectStreamException - if an error occurs
      • add

        public void add​(int field,
                        int amount)
        Method to add an amount to a field
        Overrides:
        add in class java.util.GregorianCalendar
        Parameters:
        field - The field
        amount - The amount to add
      • roll

        public void roll​(int field,
                         boolean up)
        Method to roll a field by 1.
        Overrides:
        roll in class java.util.GregorianCalendar
        Parameters:
        field - The field
        up - The whether to move it up
      • roll

        public void roll​(int field,
                         int amount)
        Method to roll the value of a field
        Overrides:
        roll in class java.util.GregorianCalendar
        Parameters:
        field - The field
        amount - The amount to roll by
      • set

        public void set​(int field,
                        int value)
        Method to set a field
        Overrides:
        set in class java.util.Calendar
        Parameters:
        field - The field
        value - The new value
      • setGregorianChange

        public void setGregorianChange​(java.util.Date date)
        Method to set the gregorian cal change date
        Overrides:
        setGregorianChange in class java.util.GregorianCalendar
        Parameters:
        date - The new change date
      • setFirstDayOfWeek

        public void setFirstDayOfWeek​(int value)
        Method to set the first day of the week
        Overrides:
        setFirstDayOfWeek in class java.util.Calendar
        Parameters:
        value - The first day of the week
      • setLenient

        public void setLenient​(boolean lenient)
        Method to set the lenient setting
        Overrides:
        setLenient in class java.util.Calendar
        Parameters:
        lenient - Whether it is lenient
      • setMinimalDaysInFirstWeek

        public void setMinimalDaysInFirstWeek​(int value)
        Method to set the minimal days in the week
        Overrides:
        setMinimalDaysInFirstWeek in class java.util.Calendar
        Parameters:
        value - The minimal days in the week
      • setTimeInMillis

        public void setTimeInMillis​(long millis)
        Method to set the time in milliseconds
        Overrides:
        setTimeInMillis in class java.util.Calendar
        Parameters:
        millis - The new time in millisecs
      • setTimeZone

        public void setTimeZone​(java.util.TimeZone value)
        Method to set the timezone
        Overrides:
        setTimeZone in class java.util.GregorianCalendar
        Parameters:
        value - The new timezone