URI

Data Structures
struct	JURI

Macros
#define	J_URI_ERROR   j_uri_error_quark()

Typedefs
typedef struct JURI	JURI

Enumerations
enum	JURIError {   J_URI_ERROR_STORE_NOT_FOUND , J_URI_ERROR_COLLECTION_NOT_FOUND , J_URI_ERROR_ITEM_NOT_FOUND , J_URI_ERROR_STORE_EXISTS ,   J_URI_ERROR_COLLECTION_EXISTS , J_URI_ERROR_ITEM_EXISTS }

Functions
G_END_DECLS G_BEGIN_DECLS GQuark	j_uri_error_quark (void)
JURI *	j_uri_new (gchar const *uri_)
void	j_uri_free (JURI *uri)
gchar const *	j_uri_get_collection_name (JURI *uri)
gchar const *	j_uri_get_item_name (JURI *uri)
gboolean	j_uri_get (JURI *uri, GError **error)
gboolean	j_uri_create (JURI *uri, gboolean with_parents, GError **error)
gboolean	j_uri_delete (JURI *uri, GError **error)
JCollection *	j_uri_get_collection (JURI *uri)
JItem *	j_uri_get_item (JURI *uri)

Detailed Description

Macro Definition Documentation

J_URI_ERROR

#define J_URI_ERROR   j_uri_error_quark()

A URI error domain.

Typedef Documentation

JURI

typedef struct JURI JURI

A URI.

Enumeration Type Documentation

JURIError

enum JURIError

A URI error code.

Enumerator
J_URI_ERROR_STORE_NOT_FOUND
J_URI_ERROR_COLLECTION_NOT_FOUND
J_URI_ERROR_ITEM_NOT_FOUND
J_URI_ERROR_STORE_EXISTS
J_URI_ERROR_COLLECTION_EXISTS
J_URI_ERROR_ITEM_EXISTS

Function Documentation

j_uri_create()

gboolean j_uri_create	(	JURI *	uri,
		gboolean	with_parents,
		GError **	error
	)

Creates the collection and item.

JURI* uri;
GError* error = NULL;
 
...
 
j_uri_create(uri, FALSE, &error);

Parameters

uri	A URI.
with_parents	Whether to create the parent objects, too.
error	An error.

Returns

TRUE on success, FALSE if an error occurred.

j_uri_delete()

gboolean j_uri_delete	(	JURI *	uri,
		GError **	error
	)

Deletes the collection and item.

JURI* uri;
GError* error = NULL;
 
...
 
j_uri_delete(uri, FALSE, &error);

Parameters

uri	A URI.
error	An error.

Returns

TRUE on success, FALSE if an error occurred.

j_uri_error_quark()

GQuark j_uri_error_quark

(

void

)

Returns the URI error quark.

Returns

The URI error quark.

j_uri_free()

void j_uri_free

(

JURI *

uri

)

Frees the memory allocated by a URI.

JURI* uri;
 
...
 
j_uri_free(uri);

Parameters

uri

A URI.

j_uri_get()

gboolean j_uri_get	(	JURI *	uri,
		GError **	error
	)

Gets the collection and item.

JURI* uri;
GError* error = NULL;
 
...
 
j_uri_get(uri, &error);

Parameters

uri	A URI.
error	An error.

Returns

TRUE on success, FALSE if an error occurred.

j_uri_get_collection()

JCollection * j_uri_get_collection

(

JURI *

uri

)

Returns the collection.

JCollection* collection;
JURI* uri;
 
...
 
collection = j_uri_get_collection(uri);

Parameters

uri

A URI.

Returns

The collection.

j_uri_get_collection_name()

gchar const * j_uri_get_collection_name

(

JURI *

uri

)

Returns the collection name.

JURI* uri;
 
...
 
g_print("%s\n", j_uri_get_collection_name(uri));

Parameters

uri

A URI.

Returns

The collection name.

j_uri_get_item()

JItem * j_uri_get_item

(

JURI *

uri

)

Returns the item.

JItem* item;
JURI* uri;
 
...
 
item = j_uri_get_item(uri);

Parameters

uri

A URI.

Returns

The item.

j_uri_get_item_name()

gchar const * j_uri_get_item_name

(

JURI *

uri

)

Returns the item name.

JURI* uri;
 
...
 
g_print("%s\n", j_uri_get_item_name(uri));

Parameters

uri

A URI.

Returns

The item name.

j_uri_new()

JURI * j_uri_new

(

gchar const *

uri_

)

Creates a new URI.

JURI* uri;
 
uri = j_uri_new("julea://foo/bar");

Parameters

uri_	A URI string.

Returns

A new URI. Should be freed with j_uri_free().