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

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFDate:

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

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

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

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

(OFComparisonResult)	- compare:
	Compares the date to another date.

(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.

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

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

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

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(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:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject: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)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject: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)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject: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.

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

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

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

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

(bool)	- isKindOfClass:
	Returns a boolean whether the object is 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.

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

(nullable id)	- performSelector:
	Performs the specified selector.

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

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

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

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

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

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

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

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

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

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

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)	+ unload
	A method which is called when the class is unloaded from the runtime.

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

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

(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.

(nullable 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.

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

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

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

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

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

(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.

(id)	+ copy
	Returns the class.

Properties
unsigned long	microsecond
	The microsecond of the date.

unsigned char	second
	The second of the date.

unsigned char	minute
	The minute of the date.

unsigned char	localMinute
	The minute of the date in local time.

unsigned char	hour
	The hour of the date.

unsigned char	localHour
	The hour of the date in local time.

unsigned char	dayOfMonth
	The day of the month of the date.

unsigned char	localDayOfMonth
	The day of the month of the date in local time.

unsigned char	monthOfYear
	The month of the year of the date.

unsigned char	localMonthOfYear
	The month of the year of the date in local time.

unsigned short	year
	The year of the date.

unsigned short	localYear
	The year of the date in local time.

unsigned char	dayOfWeek
	The day of the week of the date.

unsigned char	localDayOfWeek
	The day of the week of the date in local time.

unsigned short	dayOfYear
	The day of the year of the date.

unsigned short	localDayOfYear
	The day of the year of the date in local time.

OFTimeInterval	timeIntervalSince1970
	The seconds since 1970-01-01T00:00:00Z.

OFTimeInterval	timeIntervalSinceNow
	The seconds the date is in the future.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Properties inherited from <OFMessagePackRepresentation>
OFData *	messagePackRepresentation
	The MessagePack representation of the object as OFData.

Detailed Description

A class for storing, accessing and comparing dates.

Method Documentation

◆ compare:

- (OFComparisonResult) compare: (OFDate *) date

Compares the date to another date.

Parameters

date	The date to compare the date to

Returns: The result of the comparison

◆ date

+ (instancetype) date

Creates a new OFDate with the current date and time.

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

◆ dateByAddingTimeInterval:

- (OFDate *) dateByAddingTimeInterval: (OFTimeInterval) seconds

Creates a new date with the specified time interval added.

Parameters

seconds The seconds after the date

Returns: A new, autoreleased OFDate

◆ dateStringWithFormat:

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

Creates a string of the date with the specified format.

See the man page for strftime for information on the format.

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

Parameters

format The format for the date string

Returns: A new, autoreleased OFString

Exceptions

OFInvalidFormatException The specified format is invalid

◆ dateWithDateString:format:

+ (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 man page for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %a, %b, %d, %e, %H, %m, %M, %S, %y, %Y, %z, %%, %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

Exceptions

OFInvalidFormatException The specified format is invalid

◆ dateWithLocalDateString:format:

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

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

See the man page for strftime for information on the format.

Warning: The format is currently limited to the following format specifiers: %a, %b, %d, %e, %H, %m, %M, %S, %y, %Y, %z, %%, %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

Exceptions

OFInvalidFormatException The specified format is invalid

◆ dateWithTimeIntervalSince1970:

+ (instancetype) dateWithTimeIntervalSince1970: (OFTimeInterval) 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

◆ dateWithTimeIntervalSinceNow:

+ (instancetype) dateWithTimeIntervalSinceNow: (OFTimeInterval) 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

◆ distantFuture

+ (instancetype) distantFuture

Returns a date in the distant future.

The date is system-dependent.

Returns: A date in the distant future

◆ distantPast

+ (instancetype) distantPast

Returns a date in the distant past.

The date is system-dependent.

Returns: A date in the distant past

◆ earlierDate:

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

Returns the earlier of the two dates.

If the argument is nil, it returns the receiver.

Parameters

otherDate Another date

Returns: The earlier date of the two dates

◆ initWithDateString:format:

- (instancetype) 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 man page 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

Exceptions

OFInvalidFormatException The specified format is invalid

◆ initWithLocalDateString:format:

- (instancetype) 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 man page 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

Exceptions

OFInvalidFormatException The specified format is invalid

◆ initWithTimeIntervalSince1970:

- (instancetype) initWithTimeIntervalSince1970: (OFTimeInterval) 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

◆ initWithTimeIntervalSinceNow:

- (instancetype) initWithTimeIntervalSinceNow: (OFTimeInterval) 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

◆ laterDate:

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

Returns the later of the two dates.

If the argument is nil, it returns the receiver.

Parameters

otherDate Another date

Returns: The later date of the two dates

◆ localDateStringWithFormat:

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

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

See the man page for strftime for information on the format.

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

Parameters

format The format for the date string

Returns: A new, autoreleased OFString

Exceptions

OFInvalidFormatException The specified format is invalid

◆ timeIntervalSinceDate:

- (OFTimeInterval) 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.

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

src/OFDate.h
src/OFDate.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ compare:

◆ date

◆ dateByAddingTimeInterval:

◆ dateStringWithFormat:

◆ dateWithDateString:format:

◆ dateWithLocalDateString:format:

◆ dateWithTimeIntervalSince1970:

◆ dateWithTimeIntervalSinceNow:

◆ distantFuture

◆ distantPast

◆ earlierDate:

◆ initWithDateString:format:

◆ initWithLocalDateString:format:

◆ initWithTimeIntervalSince1970:

◆ initWithTimeIntervalSinceNow:

◆ laterDate:

◆ localDateStringWithFormat:

◆ timeIntervalSinceDate: