ObjFW
Public Member Functions | Static Public Member Functions
OFURL Class Reference

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

#import <OFURL.h>

Inheritance diagram for OFURL:
OFObject <OFCopying> <OFSerialization> <OFObject>

List of all members.

Public Member Functions

(id) - initWithString:
 Initializes an already allocated OFURL with the specified string.
(id) - initWithString:relativeToURL:
 Initializes an already allocated OFURL with the specified string and relative URL.
(OFString *) - scheme
 Returns the scheme part of the URL.
(void) - setScheme:
 Set the scheme part of the URL.
(OFString *) - host
 Returns the host part of the URL.
(void) - setHost:
 Set the host part of the URL.
(uint16_t) - port
 Returns the port part of the URL.
(void) - setPort:
 Set the port part of the URL.
(OFString *) - user
 Returns the user part of the URL.
(void) - setUser:
 Set the user part of the URL.
(OFString *) - password
 Returns the password part of the URL.
(void) - setPassword:
 Set the password part of the URL.
(OFString *) - path
 Returns the path part of the URL.
(void) - setPath:
 Set the path part of the URL.
(OFString *) - parameters
 Returns the parameters part of the URL.
(void) - setParameters:
 Set the parameters part of the URL.
(OFString *) - query
 Returns the query part of the URL.
(void) - setQuery:
 Set the query part of the URL.
(OFString *) - fragment
 Returns the fragment part of the URL.
(void) - setFragment:
 Set the fragment part of the URL.
(OFString *) - string
 Returns the URL as a string.

Static Public Member Functions

(id) + URLWithString:
(id) + URLWithString:relativeToURL:

Detailed Description

A class for parsing URLs and accessing parts of it.


Member Function Documentation

- (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
- (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
- (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: (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: (OFString*)  parameters

Set the parameters part of the URL.

Parameters:
parametersThe parameters part of the URL to set
- (void) setPassword: (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: (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: (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
+ (id) URLWithString: (OFString*)  string

Creates a new URL with the specified string.

Parameters:
stringA string describing a URL
Returns:
A new, autoreleased OFURL
+ (id) 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:
 All Classes Functions Variables Properties