ObjFW
Instance Methods | Class Methods | 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:
OFObject <OFCopying> <OFSerialization> <OFObject>

Instance Methods

(id) - initWithString:
 Initializes an already allocated OFURL with the specified string. More...
 
(id) - initWithString:relativeToURL:
 Initializes an already allocated OFURL with the specified string and relative URL. More...
 
(OFString *) - scheme
 Returns the scheme part of the URL. More...
 
(void) - setScheme:
 Set the scheme part of the URL. More...
 
(OFString *) - host
 Returns the host part of the URL. More...
 
(void) - setHost:
 Set the host part of the URL. More...
 
(uint16_t) - port
 Returns the port part of the URL. More...
 
(void) - setPort:
 Set the port part of the URL. More...
 
(nullable OFString *) - user
 Returns the user part of the URL. More...
 
(void) - setUser:
 Set the user part of the URL. More...
 
(nullable OFString *) - password
 Returns the password part of the URL. More...
 
(void) - setPassword:
 Set the password part of the URL. More...
 
(OFString *) - path
 Returns the path part of the URL. More...
 
(void) - setPath:
 Set the path part of the URL. More...
 
(nullable OFString *) - parameters
 Returns the parameters part of the URL. More...
 
(void) - setParameters:
 Set the parameters part of the URL. More...
 
(nullable OFString *) - query
 Returns the query part of the URL. More...
 
(void) - setQuery:
 Set the query part of the URL. More...
 
(nullable OFString *) - fragment
 Returns the fragment part of the URL. More...
 
(void) - setFragment:
 Set the fragment part of the URL. More...
 
(OFString *) - string
 Returns the URL as a string. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. 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: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) - 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) - 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...
 
(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...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(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 const char *) - typeEncodingForSelector:
 Returns the type encoding 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...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 
- Instance Methods inherited from <OFSerialization>
(id) - initWithSerialization:
 Initializes the object with the specified XML element serialization. More...
 
(OFXMLElement *) - XMLElementBySerializing
 Serializes the object into an XML element. More...
 

Class Methods

(instancetype) + URL
 
(instancetype) + URLWithString:
 
(instancetype) + URLWithString:relativeToURL:
 
- 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...
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(id) + new
 Allocates memory for a new instance and calls init on it. 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...
 
(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 const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding 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...
 
(nullable IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method. More...
 
(nullable IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method. 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...
 

Detailed Description

A class for parsing URLs and accessing parts of it.

Method Documentation

- (nullable OFString*) fragment

Returns the fragment part of the URL.

Returns
The fragment part of the URL
- (OFString*) host

Returns the host part of the URL.

Returns
The host part of the URL
- (id) initWithString: (OFString*)  string

Initializes an already allocated OFURL with the specified string.

Parameters
stringA string describing a URL
Returns
An initialized OFURL
- (id) 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
- (OFString *) parameters

Returns the parameters part of the URL.

Returns
The parameters part of the URL
- (nullable OFString*) password

Returns the password part of the URL.

Returns
The password part of the URL
- (OFString*) path

Returns the path part of the URL.

Returns
The path part of the URL
- (uint16_t) port

Returns the port part of the URL.

Returns
The port part of the URL
- (nullable OFString*) query

Returns the query part of the URL.

Returns
The query part of the URL
- (OFString*) scheme

Returns the scheme part of the URL.

Returns
The scheme part of the URL
- (void) setFragment: (nullable OFString *)  fragment

Set the fragment part of the URL.

Parameters
fragmentThe fragment part of the URL to set
- (void) setHost: (OFString*)  host

Set the host part of the URL.

Parameters
hostThe host part of the URL to set
- (void) setParameters: (nullable OFString *)  parameters

Set the parameters part of the URL.

Parameters
parametersThe parameters part of the URL to set
- (void) setPassword: (nullable OFString *)  password

Set the password part of the URL.

Parameters
passwordThe password part of the URL to set
- (void) setPath: (OFString*)  path

Set the path part of the URL.

Parameters
pathThe path part of the URL to set
- (void) setPort: (uint16_t)  port

Set the port part of the URL.

Parameters
portThe port part of the URL to set
- (void) setQuery: (nullable OFString *)  query

Set the query part of the URL.

Parameters
queryThe query part of the URL to set
- (void) setScheme: (OFString*)  scheme

Set the scheme part of the URL.

Parameters
schemeThe scheme part of the URL to set
- (void) setUser: (nullable OFString *)  user

Set the user part of the URL.

Parameters
userThe user part of the URL to set
- (OFString *) string

Returns the URL as a string.

Returns
The URL as a string
+ (instancetype) URL

Creates a new URL.

Returns
A new, autoreleased OFURL
+ (instancetype) URLWithString: (OFString*)  string

Creates a new URL with the specified string.

Parameters
stringA string describing a URL
Returns
A new, autoreleased OFURL
+ (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
- (OFString *) user

Returns the user part of the URL.

Returns
The user part of the URL

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