C# Class HandCoded.Finance.Date

Inheritance: TemporalDate, IComparable
Show file Open project: formicary/fpml-toolkit-csharp Class Usage Examples

Public Properties

Property Type Description
MAX_VALUE Date
MIN_VALUE Date

Public Methods

Method Description
CompareTo ( Date other ) : int

Returns the result of comparing this instance to another Date.

CompareTo ( Object other ) : int

Returns the result of comparing this instance to another Object.

Date ( int day, int month, int year ) : System

Constructs a Date instance given a day, month and year.

Date ( int day, int month, int year, bool utc ) : System

Constructs a Date instance given a day, month and year.

Date ( int day, int month, int year, int offset ) : System

Constructs a Date instance given a day, month and year.

Equals ( Date other ) : bool

Determines if this Date instance and another hold the same date.

Equals ( object other ) : bool

Determines if this Date instance and another hold the same date.

GetHashCode ( ) : int

Returns the hash value of the date for hash based data structures and algorithms.

IsLeapYear ( int year ) : bool

Determines if a year is a leap year.

MonthLength ( int month, bool leapYear ) : int

Returns the number of days in the given month in a leap or non-leap year.

MonthLength ( int month, int year ) : int

Returns the number of days in the given month for the specified year.

Parse ( String text ) : Date

Parses a DateTime instance from a character string in the ISO date format (as produced by ToString).

Plus ( Interval interval ) : Date

Creates a new Date based on the current instance and a given Interval.

PlusDays ( int days ) : Date

Creates a new Date based in the current instance and a given number of days adjustment.

PlusMonths ( int months ) : Date

Creates a new Date based on the current instance and a given number of months adjustment.

PlusWeeks ( int weeks ) : Date

Creates a new Date based on the current instance and a given number of weeks adjustment.

PlusYears ( int years ) : Date

Creates a new Date based on the current instance and a given number of years adjustment.

ToDateTime ( ) : DateTime

Creates a DateTime instance representing midnight on the morning of the current date.

ToString ( ) : string

Converts the instance data members to a string representation that can be displayed for debugging purposes.

Private Methods

Method Description
Date ( DateValue dateValue, TimeZone timeZone ) : System

Constructs a Date using its DateValue and TimeZone components.

Method Details

CompareTo() public method

Returns the result of comparing this instance to another Date.
public CompareTo ( Date other ) : int
other Date The Date instance to compare with.
return int

CompareTo() public method

Returns the result of comparing this instance to another Object.
If the argument is not a /// Date instance.
public CompareTo ( Object other ) : int
other Object The instance to compare with.
return int

Date() public method

Constructs a Date instance given a day, month and year.
public Date ( int day, int month, int year ) : System
day int The day of the month (1-31).
month int The month of the year (1-12).
year int The year (1900-2099).
return System

Date() public method

Constructs a Date instance given a day, month and year.
public Date ( int day, int month, int year, bool utc ) : System
day int The day of the month (1-31).
month int The month of the year (1-12).
year int The year (1900-2099).
utc bool Indicates UTC time zone.
return System

Date() public method

Constructs a Date instance given a day, month and year.
public Date ( int day, int month, int year, int offset ) : System
day int The day of the month (1-31).
month int The month of the year (1-12).
year int The year (1900-2099).
offset int The time zone offset.
return System

Equals() public method

Determines if this Date instance and another hold the same date.
public Equals ( Date other ) : bool
other Date The Date instance to compare with.
return bool

Equals() public method

Determines if this Date instance and another hold the same date.
public Equals ( object other ) : bool
other object The instance to compare with.
return bool

GetHashCode() public method

Returns the hash value of the date for hash based data structures and algorithms.
public GetHashCode ( ) : int
return int

IsLeapYear() public static method

Determines if a year is a leap year.
public static IsLeapYear ( int year ) : bool
year int The year to test (1900-2099)
return bool

MonthLength() public static method

Returns the number of days in the given month in a leap or non-leap year.
public static MonthLength ( int month, bool leapYear ) : int
month int The month number (1-12).
leapYear bool Flag to indicate a leap year.
return int

MonthLength() public static method

Returns the number of days in the given month for the specified year.
public static MonthLength ( int month, int year ) : int
month int The month number (1-12).
year int The year (1900-2099).
return int

Parse() public static method

Parses a DateTime instance from a character string in the ISO date format (as produced by ToString).
If the character string is not in the /// correct format.
public static Parse ( String text ) : Date
text String The text string to be parsed.
return Date

Plus() public method

Creates a new Date based on the current instance and a given Interval.
public Plus ( Interval interval ) : Date
interval Interval The time .
return Date

PlusDays() public method

Creates a new Date based in the current instance and a given number of days adjustment.
public PlusDays ( int days ) : Date
days int The number of days to adjust by.
return Date

PlusMonths() public method

Creates a new Date based on the current instance and a given number of months adjustment.
public PlusMonths ( int months ) : Date
months int The number of months to adjust by.
return Date

PlusWeeks() public method

Creates a new Date based on the current instance and a given number of weeks adjustment.
public PlusWeeks ( int weeks ) : Date
weeks int The number of weeks to adjust by.
return Date

PlusYears() public method

Creates a new Date based on the current instance and a given number of years adjustment.
public PlusYears ( int years ) : Date
years int The number of years to adjust by.
return Date

ToDateTime() public method

Creates a DateTime instance representing midnight on the morning of the current date.
public ToDateTime ( ) : DateTime
return DateTime

ToString() public method

Converts the instance data members to a string representation that can be displayed for debugging purposes.
public ToString ( ) : string
return string

Property Details

MAX_VALUE public static property

The latest possible date that can be correctly represented.
public static Date MAX_VALUE
return Date

MIN_VALUE public static property

The earliest possible date that can be correctly represented,
public static Date MIN_VALUE
return Date