/*
 * Java-Gnome Bindings Library
 *
 * Copyright 1998-2004 the Java-Gnome Team, all rights reserved.
 *
 * The Java-Gnome bindings library is free software distributed under
 * the terms of the GNU Library General Public License version 2.
 */

package org.gnu.glib;

/**
 * A Quark is an association between a String and an integer
 * identifier.  Given either the String or the Quark it is 
 * possible to retrieve the other.  This object is used primarily
 * inside of the bindings.  The external interface should use a
 * standard java type like Property.
 */

public class Quark extends Boxed {
	/**
	 * Create a Quark object.
	 * 
	 * @param string The string value associated with this Quark.
	 */
	public Quark(String string) {
		super();
		handle = Quark.g_quark_from_string(string);
	}

	/**
	 * This is the method that allows one to construct a Quark
	 * once a native peer has been provided.
	 * 
	 * @param handle The native peer that was returned from
	 * a call to the native libraries.
	 */
	public Quark(Handle handle) {
		this.handle = handle;
	}

	/**
	 * Retrieve the string value associated with this Quark.
	 * 
	 * @return The string value
	 */
	public final String getString() {
		return Quark.g_quark_to_string(handle);
	}

	/**
	 * Find a Quark that is associated with the given string.
	 * If one is not found a null value is returned.
	 * 
	 * @param string The string value to use for the search
	 * @return The Quark value associated with the string or
	 * null if one is not found.
	 */
	public static final Quark findQuark(String string) {
		Handle hndl = Quark.g_quark_try_string(string);
		if (hndl == null)
			return null;
		else
			return new Quark(hndl);
	}

	/****************************************
	 * BEGINNING OF GENERATED CODE
	 ****************************************/
	native static final protected Handle g_quark_from_string(String str);
	native static final protected Handle g_quark_try_string(String str);
	native static final protected String g_quark_to_string(Handle quark);
	/****************************************
	 * END OF GENERATED CODE
	 ****************************************/
}