com.prolificinteractive.materialcalendarview

Class CalendarDay

java.lang.Object

com.prolificinteractive.materialcalendarview.CalendarDay

All Implemented Interfaces:

android.os.Parcelable

public final class CalendarDay
extends java.lang.Object
implements android.os.Parcelable

An imputable representation of a day on a calendar

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<CalendarDay>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CalendarDay() Deprecated.
CalendarDay(java.util.Calendar calendar) Deprecated.
CalendarDay(java.util.Date date) Deprecated.
CalendarDay(int year, int month, int day) Deprecated.
CalendarDay(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
void	copyTo(java.util.Calendar calendar) Copy this day's information to the given calendar instance
int	describeContents()
boolean	equals(java.lang.Object o)
static CalendarDay	from(java.util.Calendar calendar) Get a new instance set to the specified day
static CalendarDay	from(java.util.Date date) Get a new instance set to the specified day
static CalendarDay	from(int year, int month, int day) Get a new instance set to the specified day
java.util.Calendar	getCalendar() Get this day as a Calendar
java.util.Date	getDate() Get this day as a Date
int	getDay() Get the day
int	getMonth() Get the month, represented by values from Calendar
int	getYear() Get the year
int	hashCode()
boolean	isAfter(CalendarDay other) Determine if this day is after the given instance
boolean	isBefore(CalendarDay other) Determine if this day is before the given instance
boolean	isInRange(CalendarDay minDate, CalendarDay maxDate) Determine if this day is within a specified range
static CalendarDay	today() Get a new instance set to today
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<CalendarDay> CREATOR

Constructor Detail

CalendarDay

@Deprecated
public CalendarDay()

Deprecated.

Initialized to the current day

See Also:

today()

CalendarDay

@Deprecated
public CalendarDay(java.util.Calendar calendar)

Deprecated.

Parameters:

calendar - source to pull date information from for this instance

See Also:

from(Calendar)

CalendarDay

@Deprecated
public CalendarDay(int year,
                               int month,
                               int day)

Deprecated.

Parameters:

year - new instance's year

month - new instance's month as defined by Calendar

day - new instance's day of month

See Also:

from(Calendar)

CalendarDay

@Deprecated
public CalendarDay(java.util.Date date)

Deprecated.

Parameters:

date - source to pull date information from for this instance

See Also:

from(Date)

CalendarDay

public CalendarDay(android.os.Parcel in)

Method Detail

today

@NonNull
public static CalendarDay today()

Get a new instance set to today

Returns:

CalendarDay set to today's date

from

@NonNull
public static CalendarDay from(int year,
                                        int month,
                                        int day)

Get a new instance set to the specified day

Parameters:

year - new instance's year

month - new instance's month as defined by Calendar

day - new instance's day of month

Returns:

CalendarDay set to the specified date

from

public static CalendarDay from(@Nullable
                               java.util.Calendar calendar)

Get a new instance set to the specified day

Parameters:

calendar - Calendar to pull date information from. Passing null will return null

Returns:

CalendarDay set to the specified date

from

public static CalendarDay from(@Nullable
                               java.util.Date date)

Get a new instance set to the specified day

Parameters:

date - Date to pull date information from. Passing null will return null.

Returns:

CalendarDay set to the specified date

getYear

public int getYear()

Get the year

Returns:

the year for this day

getMonth

public int getMonth()

Get the month, represented by values from Calendar

Returns:

the month of the year as defined by Calendar

getDay

public int getDay()

Get the day

Returns:

the day of the month for this day

getDate

@NonNull
public java.util.Date getDate()

Get this day as a Date

Returns:

a date with this days information

getCalendar

@NonNull
public java.util.Calendar getCalendar()

Get this day as a Calendar

Returns:

a new calendar instance with this day information

copyTo

public void copyTo(@NonNull
                   java.util.Calendar calendar)

Copy this day's information to the given calendar instance

Parameters:

calendar - calendar to set date information to

isInRange

public boolean isInRange(@Nullable
                         CalendarDay minDate,
                         @Nullable
                         CalendarDay maxDate)

Determine if this day is within a specified range

Parameters:

minDate - the earliest day, may be null

maxDate - the latest day, may be null

Returns:

true if the between (inclusive) the min and max dates.

isBefore

public boolean isBefore(@NonNull
                        CalendarDay other)

Determine if this day is before the given instance

Parameters:

other - the other day to test

Returns:

true if this is before other, false if equal or after

isAfter

public boolean isAfter(@NonNull
                       CalendarDay other)

Determine if this day is after the given instance

Parameters:

other - the other day to test

Returns:

true if this is after other, false if equal or before

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable