A class for storing, accessing and comparing dates. More...

#import <OFDate.h>

Inheritance diagram for OFDate:

Instance Methods
(id)	- initWithTimeIntervalSince1970:
	Initializes an already allocated OFDate with the specified date and time since 1970-01-01T00:00:00Z.

(id)	- initWithTimeIntervalSinceNow:
	Initializes an already allocated OFDate with the specified date and time since now.

(id)	- initWithDateString:format:
	Initializes an already allocated OFDate with the specified string in the specified format.

(id)	- initWithLocalDateString:format:
	Initializes an already allocated OFDate with the specified string in the specified format.

(uint32_t)	- microsecond
	Returns the microsecond of the date.

(uint8_t)	- second
	Returns the second of the date.

(uint8_t)	- minute
	Returns the minute of the date.

(uint8_t)	- hour
	Returns the hour of the date.

(uint8_t)	- localHour
	Returns the hour of the date in local time.

(uint8_t)	- dayOfMonth
	Returns the day of the month.

(uint8_t)	- localDayOfMonth
	Returns the day of the month of the date in local time.

(uint8_t)	- monthOfYear
	Returns the month of the year of the date.

(uint8_t)	- localMonthOfYear
	Returns the month of the year of the date in local time.

(uint16_t)	- year
	Returns the year of the date.

(uint16_t)	- localYear
	Returns the year of the date in local time.

(uint8_t)	- dayOfWeek
	Returns the day of the week of the date.

(uint8_t)	- localDayOfWeek
	Returns the day of the week of the date in local time.

(uint16_t)	- dayOfYear
	Returns the day of the year of the date.

(uint16_t)	- localDayOfYear
	Returns the day of the year of the date in local time.

(OFString *)	- dateStringWithFormat:
	Creates a string of the date with the specified format.

(OFString *)	- localDateStringWithFormat:
	Creates a string of the local date with the specified format.

(OFDate *)	- earlierDate:
	Returns the earlier of the two dates.

(OFDate *)	- laterDate:
	Returns the later of the two dates.

(double)	- timeIntervalSince1970
	Returns the seconds since 1970-01-01T00:00:00Z.

(double)	- timeIntervalSinceDate:
	Returns the seconds the receiver is after the date.

(double)	- timeIntervalSinceNow
	Returns the seconds the receiver is in the future.

(OFDate *)	- dateByAddingTimeInterval:
	Creates a new date with the specified time interval added.

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.

(OFString *)	- className
	Returns the name of the object's class.

(OFString *)	- description
	Returns a description for the object.

(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool.

(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.

(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.

(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.

Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind.

(BOOL)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(BOOL)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.

(id)	- performSelector:
	Performs the specified selector.

(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(BOOL)	- isEqual:
	Checks two objects for equality.

(uint32_t)	- hash
	Calculates a hash for the object.

(id)	- retain
	Increases the retain count.

(unsigned int)	- retainCount
	Returns the retain count.

(void)	- release
	Decreases the retain count.

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.

(id)	- self
	Returns the receiver.

(BOOL)	- isProxy
	Returns whether the object is a proxy object.

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.

Instance Methods inherited from <OFComparing>
(of_comparison_result_t)	- compare:
	Compares the object with another object.

Instance Methods inherited from <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization.

(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element.

Class Methods
(instancetype)	+ date
	Creates a new OFDate with the current date and time.

(instancetype)	+ dateWithTimeIntervalSince1970:
	Creates a new OFDate with the specified date and time since 1970-01-01T00:00:00Z.

(instancetype)	+ dateWithTimeIntervalSinceNow:
	Creates a new OFDate with the specified date and time since now.

(instancetype)	+ dateWithDateString:format:
	Creates a new OFDate with the specified string in the specified format.

(instancetype)	+ dateWithLocalDateString:format:
	Creates a new OFDate with the specified string in the specified format.

(instancetype)	+ distantFuture
	Returns a date in the distant future.

(instancetype)	+ distantPast
	Returns a date in the distant past.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(id)	+ new
	Allocates memory for a new instance and calls init on it.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(BOOL)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(Class)	+ superclass
	Returns the superclass of the class.

(BOOL)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(BOOL)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method.

(IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method.

(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

Detailed Description

A class for storing, accessing and comparing dates.

Method Documentation

+ (instancetype) date

Creates a new OFDate with the current date and time.

Returns: A new, autoreleased OFDate with the current date and time

- (OFDate *) dateByAddingTimeInterval: (double) seconds

Creates a new date with the specified time interval added.

Parameters

seconds The seconds after the date

Returns: A new, autoreleased OFDate

- (OFString *) dateStringWithFormat: (OFConstantString*) format

Creates a string of the date with the specified format.

See the manpage for strftime for information on the format.

Parameters

format The format for the date string

Returns: A new, autoreleased OFString

+ (instancetype) dateWithDateString:	(OFString*)	string
format:	(OFString*)	format

Creates a new OFDate with the specified string in the specified format.

The time zone used is UTC. See dateWithLocalDateString:format: if you want local time.

See the manpage for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t.

Parameters

string	The string describing the date
format	The format of the string describing the date

Returns: A new, autoreleased OFDate with the specified date and time

+ (instancetype) dateWithLocalDateString:	(OFString*)	string
format:	(OFString*)	format

Creates a new OFDate with the specified string in the specified format.

See the manpage for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t.

Parameters

string	The string describing the date
format	The format of the string describing the date

Returns: A new, autoreleased OFDate with the specified date and time

+ (instancetype) dateWithTimeIntervalSince1970: (double) seconds

Creates a new OFDate with the specified date and time since 1970-01-01T00:00:00Z.

Parameters

seconds The seconds since 1970-01-01T00:00:00Z

Returns: A new, autoreleased OFDate with the specified date and time

+ (instancetype) dateWithTimeIntervalSinceNow: (double) seconds

Creates a new OFDate with the specified date and time since now.

Parameters

seconds The seconds since now

Returns: A new, autoreleased OFDate with the specified date and time

- (uint8_t) dayOfMonth

Returns the day of the month.

Returns: The day of the month of the date

- (uint8_t) dayOfWeek

Returns the day of the week of the date.

Returns: The day of the week of the date

- (uint16_t) dayOfYear

Returns the day of the year of the date.

Returns: The day of the year of the date

+ (instancetype) distantFuture

Returns a date in the distant future.

The date is system-dependant.

Returns: A date in the distant future

+ (instancetype) distantPast

Returns a date in the distant past.

The date is system-dependant.

Returns: A date in the distant past

- (OFDate *) earlierDate: (OFDate*) otherDate

Returns the earlier of the two dates.

Parameters

otherDate Another date

Returns: The earlier date of the two dates

- (uint8_t) hour

Returns the hour of the date.

Returns: The hour of the date

- (id) initWithDateString:	(OFString*)	string
format:	(OFString*)	format

Initializes an already allocated OFDate with the specified string in the specified format.

The time zone used is UTC. If a time zone is specified anyway, an OFInvalidFormatException is thrown. See initWithLocalDateString:format: if you want to specify a time zone.

See the manpage for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t.

Parameters

string	The string describing the date
format	The format of the string describing the date

Returns: An initialized OFDate with the specified date and time

- (id) initWithLocalDateString:	(OFString*)	string
format:	(OFString*)	format

Initializes an already allocated OFDate with the specified string in the specified format.

If no time zone is specified, local time is assumed.

See the manpage for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %d, %e, %H, %m, %M, %S, %y, %Y, %%, %n and %t.

Parameters

string	The string describing the date
format	The format of the string describing the date

Returns: An initialized OFDate with the specified date and time

- (id) initWithTimeIntervalSince1970: (double) seconds

Initializes an already allocated OFDate with the specified date and time since 1970-01-01T00:00:00Z.

Parameters

seconds The seconds since 1970-01-01T00:00:00Z

Returns: An initialized OFDate with the specified date and time

- (id) initWithTimeIntervalSinceNow: (double) seconds

Initializes an already allocated OFDate with the specified date and time since now.

Parameters

seconds The seconds since now

Returns: An initialized OFDate with the specified date and time

- (OFDate *) laterDate: (OFDate*) otherDate

Returns the later of the two dates.

Parameters

otherDate Another date

Returns: The later date of the two dates

- (OFString *) localDateStringWithFormat: (OFConstantString*) format

Creates a string of the local date with the specified format.

See the manpage for strftime for information on the format.

Parameters

format The format for the date string

Returns: A new, autoreleased OFString

- (uint8_t) localDayOfMonth

Returns the day of the month of the date in local time.

Returns: The day of the month of the date in local time

- (uint8_t) localDayOfWeek

Returns the day of the week of the date in local time.

Returns: The day of the week of the date in local time

- (uint16_t) localDayOfYear

Returns the day of the year of the date in local time.

Returns: The day of the year of the date in local time

- (uint8_t) localHour

Returns the hour of the date in local time.

Returns: The hour of the date in local time

- (uint8_t) localMonthOfYear

Returns the month of the year of the date in local time.

Returns: The month of the year of the date in local time

- (uint16_t) localYear

Returns the year of the date in local time.

Returns: The year of the date in local time

- (uint32_t) microsecond

Returns the microsecond of the date.

Returns: The microsecond of the date

- (uint8_t) minute

Returns the minute of the date.

Returns: The minute of the date

- (uint8_t) monthOfYear

Returns the month of the year of the date.

Returns: The month of the year of the date

- (uint8_t) second

Returns the second of the date.

Returns: The second of the date

- (double) timeIntervalSince1970

Returns the seconds since 1970-01-01T00:00:00Z.

Returns: The seconds since 1970-01-01T00:00:00Z

- (double) timeIntervalSinceDate: (OFDate*) otherDate

Returns the seconds the receiver is after the date.

Parameters

otherDate Date date to generate the difference with receiver

Returns: The seconds the receiver is after the date.

- (double) timeIntervalSinceNow

Returns the seconds the receiver is in the future.

Returns: The seconds the receiver is in the future

- (uint16_t) year

Returns the year of the date.

Returns: The year of the date

The documentation for this class was generated from the following files:

src/OFDate.h
src/OFDate.m

Instance Methods

Class Methods

Detailed Description

Method Documentation