UnmodifiableCalendar (AO Code Public 1.2 API)

java.lang.Object
- java.util.Calendar
- - com.aoindustries.util.UnmodifiableCalendar

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Calendar>
```
public final class UnmodifiableCalendar
extends Calendar
```
Wraps a Calendar to make it unmodifiable.

Author:

AO Industries, Inc.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.Calendar
  Calendar.Builder

Field Summary
- 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 Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int field, int amount)`
`boolean`	`after(Object when)`
`boolean`	`before(Object when)`
`UnmodifiableCalendar`	`clone()`
`int`	`compareTo(Calendar anotherCalendar)`
`protected void`	`complete()`
`protected void`	`computeFields()`
`protected void`	`computeTime()`
`boolean`	`equals(Object obj)`
`int`	`get(int field)`
`int`	`getActualMaximum(int field)`
`int`	`getActualMinimum(int field)`
`String`	`getDisplayName(int field, int style, Locale locale)`
`Map<String,Integer>`	`getDisplayNames(int field, int style, Locale locale)`
`int`	`getFirstDayOfWeek()`
`int`	`getGreatestMinimum(int field)`
`int`	`getLeastMaximum(int field)`
`int`	`getMaximum(int field)`
`int`	`getMinimalDaysInFirstWeek()`
`int`	`getMinimum(int field)`
`long`	`getTimeInMillis()`
`TimeZone`	`getTimeZone()`
`int`	`hashCode()`
`boolean`	`isLenient()`
`void`	`roll(int field, boolean up)`
`void`	`roll(int field, int amount)`
`void`	`set(int field, int value)`
`void`	`setFirstDayOfWeek(int value)`
`void`	`setLenient(boolean lenient)`
`void`	`setMinimalDaysInFirstWeek(int value)`
`void`	`setTimeInMillis(long millis)`
`void`	`setTimeZone(TimeZone value)`
`String`	`toString()`
`static Calendar`	`unwrapClone(Calendar cal)` Unwraps and returns a modifiable clone of the given calendar.
`static UnmodifiableCalendar`	`wrap(Calendar cal)` Wraps the calendar if needed.

Methods inherited from class java.util.Calendar
clear, clear, getAvailableCalendarTypes, getAvailableLocales, getCalendarType, getInstance, getInstance, getInstance, getInstance, getTime, getWeeksInWeekYear, getWeekYear, internalGet, isSet, isWeekDateSupported, set, set, set, setTime, setWeekDate, toInstant

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - wrap
```
public static UnmodifiableCalendar wrap(Calendar cal)
```
    Wraps the calendar if needed. If null, null is returned. If already unmodifiable, parameter is returned without additional wrapping.
  - unwrapClone
```
public static Calendar unwrapClone(Calendar cal)
```
    Unwraps and returns a modifiable clone of the given calendar.
  - add
```
public void add(int field,
                int amount)
```
    Specified by:
    
    add in class Calendar
  - after
```
public boolean after(Object when)
```
    Overrides:
    
    after in class Calendar
  - before
```
public boolean before(Object when)
```
    Overrides:
    
    before in class Calendar
  - clone
```
public UnmodifiableCalendar clone()
```
    Overrides:
    
    clone in class Calendar
  - compareTo
```
public int compareTo(Calendar anotherCalendar)
```
    Specified by:
    
    compareTo in interface Comparable<Calendar>
    
    Overrides:
    
    compareTo in class Calendar
  - complete
```
protected void complete()
```
    Overrides:
    
    complete in class Calendar
  - computeFields
```
protected void computeFields()
```
    Specified by:
    
    computeFields in class Calendar
  - computeTime
```
protected void computeTime()
```
    Specified by:
    
    computeTime in class Calendar
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Calendar
  - get
```
public int get(int field)
```
    Overrides:
    
    get in class Calendar
  - getActualMaximum
```
public int getActualMaximum(int field)
```
    Overrides:
    
    getActualMaximum in class Calendar
  - getActualMinimum
```
public int getActualMinimum(int field)
```
    Overrides:
    
    getActualMinimum in class Calendar
  - getDisplayName
```
public String getDisplayName(int field,
                             int style,
                             Locale locale)
```
    Overrides:
    
    getDisplayName in class Calendar
  - getDisplayNames
```
public Map<String,Integer> getDisplayNames(int field,
                                           int style,
                                           Locale locale)
```
    Overrides:
    
    getDisplayNames in class Calendar
  - getFirstDayOfWeek
```
public int getFirstDayOfWeek()
```
    Overrides:
    
    getFirstDayOfWeek in class Calendar
  - getGreatestMinimum
```
public int getGreatestMinimum(int field)
```
    Specified by:
    
    getGreatestMinimum in class Calendar
  - getLeastMaximum
```
public int getLeastMaximum(int field)
```
    Specified by:
    
    getLeastMaximum in class Calendar
  - getMaximum
```
public int getMaximum(int field)
```
    Specified by:
    
    getMaximum in class Calendar
  - getMinimalDaysInFirstWeek
```
public int getMinimalDaysInFirstWeek()
```
    Overrides:
    
    getMinimalDaysInFirstWeek in class Calendar
  - getMinimum
```
public int getMinimum(int field)
```
    Specified by:
    
    getMinimum in class Calendar
  - getTimeInMillis
```
public long getTimeInMillis()
```
    Overrides:
    
    getTimeInMillis in class Calendar
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Overrides:
    
    getTimeZone in class Calendar
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Calendar
  - isLenient
```
public boolean isLenient()
```
    Overrides:
    
    isLenient in class Calendar
  - roll
```
public void roll(int field,
                 boolean up)
```
    Specified by:
    
    roll in class Calendar
  - roll
```
public void roll(int field,
                 int amount)
```
    Overrides:
    
    roll in class Calendar
  - set
```
public void set(int field,
                int value)
```
    Overrides:
    
    set in class Calendar
  - setFirstDayOfWeek
```
public void setFirstDayOfWeek(int value)
```
    Overrides:
    
    setFirstDayOfWeek in class Calendar
  - setLenient
```
public void setLenient(boolean lenient)
```
    Overrides:
    
    setLenient in class Calendar
  - setMinimalDaysInFirstWeek
```
public void setMinimalDaysInFirstWeek(int value)
```
    Overrides:
    
    setMinimalDaysInFirstWeek in class Calendar
  - setTimeInMillis
```
public void setTimeInMillis(long millis)
```
    Overrides:
    
    setTimeInMillis in class Calendar
  - setTimeZone
```
public void setTimeZone(TimeZone value)
```
    Overrides:
    
    setTimeZone in class Calendar
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Calendar

Class UnmodifiableCalendar

Nested Class Summary

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

Field Summary

Fields inherited from class java.util.Calendar

Method Summary

Methods inherited from class java.util.Calendar

Methods inherited from class java.lang.Object

Method Detail

wrap

unwrapClone

add

after

before

clone

compareTo

complete

computeFields

computeTime

equals

get

getActualMaximum

getActualMinimum

getDisplayName

getDisplayNames

getFirstDayOfWeek

getGreatestMinimum

getLeastMaximum

getMaximum

getMinimalDaysInFirstWeek

getMinimum

getTimeInMillis

getTimeZone

hashCode

isLenient

roll

roll

set

setFirstDayOfWeek

setLenient

setMinimalDaysInFirstWeek

setTimeInMillis

setTimeZone

toString