gomgenerator.java

lucene2.2.0版本

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.gdata.gom;

/**
 * Class representing the "atom:generator" element. The "atom:generator"
 * element's content identifies the agent used to generate a feed, for debugging
 * and other purposes.
 * 
 * <pre>
 *   atomGenerator = element atom:generator {
 *   atomCommonAttributes,
 *   attribute uri { atomUri }?,
 *   attribute version { text }?,
 *   text
 *   }
 * </pre>
 * 
 * 
 * @author Simon Willnauer
 * 
 */
public interface GOMGenerator extends GOMElement {
	/**
	 * Atom local name for the xml element
	 */
	public static final String LOCALNAME = "generator";

	/**
	 * Sets the the atom:generator <i>uri</i> attribute value
	 * 
	 * @param uri -
	 *            the generator <i>uri</i> attribute value to set
	 */
	public void setUri(String uri);

	/**
	 * Sets the the atom:generator <i>version</i> attribute value
	 * 
	 * @param version -
	 *            the version value to set
	 */
	public void setGeneratorVersion(String version);

	/**
	 * 
	 * @return - the atom:generator <i>version</i> attribute value
	 */
	public String getGeneratorVersion();

	/**
	 * 
	 * @return - the atom:generator <i>uri</i> attribute value
	 */
	public String getUri();
}