ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFURL Class Reference

A class for parsing URLs and accessing parts of it. More...

#import <ObjFW/OFURL.h>

Inheritance diagram for OFURL:
Inheritance graph
[legend]
Collaboration diagram for OFURL:
Collaboration graph
[legend]

Instance Methods

(instancetype) - initWithString:
 Initializes an already allocated OFURL with the specified string. More...
 
(instancetype) - initWithString:relativeToURL:
 Initializes an already allocated OFURL with the specified string and relative URL. More...
 
(instancetype) - initFileURLWithPath:
 Initializes an already allocated OFURL with the specified local file path. More...
 
(instancetype) - initFileURLWithPath:isDirectory:
 Initializes an already allocated OFURL with the specified local file path. More...
 
(OFURL *) - URLByAppendingPathComponent:
 Returns a new URL with the specified path component appended. More...
 
(OFURL *) - URLByAppendingPathComponent:isDirectory:
 Returns a new URL with the specified path component appended. More...
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object. More...
 
(nullable OFMethodSignature *) - methodSignatureForSelector:
 Returns the method signature for the specified selector. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(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. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
- Instance Methods inherited from <OFObject>
(unsigned long) - hash
 Returns a 32 bit hash for the object. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the object allows weak references. More...
 
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP- methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable id- performSelector:
 Performs the specified selector. More...
 
(nullable id- performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id- performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(instancetype) - retain
 Increases the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...
 
(instancetype) - self
 Returns the receiver. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 
- Instance Methods inherited from <OFCopying>
(id- copy
 Copies the object. More...
 
- Instance Methods inherited from <OFMutableCopying>
(id- mutableCopy
 Creates a mutable copy of the object. More...
 
- Instance Methods inherited from <OFSerialization>
(instancetype) - initWithSerialization:
 Initializes the object with the specified XML element serialization. More...
 

Class Methods

(instancetype) + URLWithString:
 Creates a new URL with the specified string. More...
 
(instancetype) + URLWithString:relativeToURL:
 Creates a new URL with the specified string relative to the specified URL. More...
 
(instancetype) + fileURLWithPath:
 Creates a new URL with the specified local file path. More...
 
(instancetype) + fileURLWithPath:isDirectory:
 Creates a new URL with the specified local file path. More...
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime. More...
 
(void) + unload
 A method which is called when the class is unloaded from the runtime. More...
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made. More...
 
(instancetype) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(instancetype) + new
 Calls alloc on self and then init on the returned object. More...
 
(Class+ class
 Returns the class. More...
 
(OFString *) + className
 Returns the name of the class as a string. More...
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class. More...
 
(nullable Class+ superclass
 Returns the superclass of the class. More...
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector. More...
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol. More...
 
(nullable IMP+ instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector. More...
 
(nullable OFMethodSignature *) + instanceMethodSignatureForSelector:
 Returns the method signature of the instance method for the specified selector. More...
 
(OFString *) + description
 Returns a description for the class, which is usually the class name. More...
 
(nullable IMP+ replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class. More...
 
(nullable IMP+ replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class. More...
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver. More...
 
(bool) + resolveClassMethod:
 Try to resolve the specified class method. More...
 
(bool) + resolveInstanceMethod:
 Try to resolve the specified instance method. More...
 
(id+ copy
 Returns the class. More...
 

Properties

OFStringscheme
 The scheme part of the URL.
 
OFStringURLEncodedScheme
 The scheme part of the URL in URL-encoded form.
 
OFStringhost
 The host part of the URL.
 
OFStringURLEncodedHost
 The host part of the URL in URL-encoded form.
 
OFNumberport
 The port part of the URL.
 
OFStringuser
 The user part of the URL.
 
OFStringURLEncodedUser
 The user part of the URL in URL-encoded form.
 
OFStringpassword
 The password part of the URL.
 
OFStringURLEncodedPassword
 The password part of the URL in URL-encoded form.
 
OFStringpath
 The path part of the URL.
 
OFStringURLEncodedPath
 The path part of the URL in URL-encoded form.
 
OFArraypathComponents
 The path of the URL split into components. More...
 
OFStringlastPathComponent
 The last path component of the URL. More...
 
OFStringquery
 The query part of the URL.
 
OFStringURLEncodedQuery
 The query part of the URL in URL-encoded form.
 
OFDictionaryqueryDictionary
 The query part of the URL as a dictionary. More...
 
OFStringfragment
 The fragment part of the URL.
 
OFStringURLEncodedFragment
 The fragment part of the URL in URL-encoded form.
 
OFStringstring
 The URL as a string.
 
OFURLURLByStandardizingPath
 The URL with relative sub paths resolved.
 
OFStringfileSystemRepresentation
 The local file system representation for a file URL. More...
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object. More...
 
OFStringstringBySerializing
 The object serialized as a string.
 
- Properties inherited from <OFSerialization>
OFXMLElementXMLElementBySerializing
 The object serialized into an XML element.
 

Detailed Description

A class for parsing URLs and accessing parts of it.

Method Documentation

◆ fileURLWithPath:

+ (instancetype) fileURLWithPath: (OFString *)  path

Creates a new URL with the specified local file path.

If a directory exists at the specified path, a slash is appended if there is no slash yet.

Parameters
pathThe local file path
Returns
A new, autoreleased OFURL

◆ fileURLWithPath:isDirectory:

+ (instancetype) fileURLWithPath: (OFString *)  path
isDirectory: (bool)  isDirectory 

Creates a new URL with the specified local file path.

Parameters
pathThe local file path
isDirectoryWhether the path is a directory, in which case a slash is appened if there is no slash yet
Returns
An Initialized OFURL

◆ initFileURLWithPath:

- (instancetype) initFileURLWithPath: (OFString *)  path

Initializes an already allocated OFURL with the specified local file path.

If a directory exists at the specified path, a slash is appended if there is no slash yet.

Parameters
pathThe local file path
Returns
An initialized OFURL

◆ initFileURLWithPath:isDirectory:

- (instancetype) initFileURLWithPath: (OFString *)  path
isDirectory: (bool)  isDirectory 

Initializes an already allocated OFURL with the specified local file path.

Parameters
pathThe local file path
isDirectoryWhether the path is a directory, in which case a slash is appened if there is no slash yet
Returns
An Initialized OFURL

◆ initWithString:

- (instancetype) initWithString: (OFString *)  string

Initializes an already allocated OFURL with the specified string.

Parameters
stringA string describing a URL
Returns
An initialized OFURL

◆ initWithString:relativeToURL:

- (instancetype) initWithString: (OFString *)  string
relativeToURL: (OFURL *)  URL 

Initializes an already allocated OFURL with the specified string and relative URL.

Parameters
stringA string describing a URL
URLA URL to which the string is relative
Returns
An initialized OFURL

◆ URLByAppendingPathComponent:

- (OFURL *) URLByAppendingPathComponent: (OFString *)  component

Returns a new URL with the specified path component appended.

If the URL is a file URL, the file system is queried whether the appended component is a directory.

Parameters
componentThe path component to append. If it starts with the slash, the component is not appended, but replaces the path instead.
Returns
A new URL with the specified path component appended

◆ URLByAppendingPathComponent:isDirectory:

- (OFURL *) URLByAppendingPathComponent: (OFString *)  component
isDirectory: (bool)  isDirectory 

Returns a new URL with the specified path component appended.

Parameters
componentThe path component to append. If it starts with the slash, the component is not appended, but replaces the path instead.
isDirectoryWhether the appended component is a directory, meaning that the URL path should have a trailing slash
Returns
A new URL with the specified path component appended

◆ URLWithString:

+ (instancetype) URLWithString: (OFString *)  string

Creates a new URL with the specified string.

Parameters
stringA string describing a URL
Returns
A new, autoreleased OFURL

◆ URLWithString:relativeToURL:

+ (instancetype) URLWithString: (OFString *)  string
relativeToURL: (OFURL *)  URL 

Creates a new URL with the specified string relative to the specified URL.

Parameters
stringA string describing a URL
URLAn URL to which the string is relative
Returns
A new, autoreleased OFURL

Property Documentation

◆ fileSystemRepresentation

- (OFString *) fileSystemRepresentation
readwriteatomic

The local file system representation for a file URL.

Note
This only exists for URLs with the file scheme and throws an exception otherwise.

◆ lastPathComponent

- (OFString *) lastPathComponent
readwriteatomic

The last path component of the URL.

Returns the empty string if the path is the root.

◆ pathComponents

- (OFArray *) pathComponents
readwriteatomic

The path of the URL split into components.

The first component must always be / to designate the root.

◆ queryDictionary

- (OFDictionary *) queryDictionary
readwriteatomic

The query part of the URL as a dictionary.

For example, a query like key1=value1&key2=value2 would correspond to the following dictionary:

@{
    @"key1": "value1",
    @"key2": "value2"
}

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