org.apache.juneau.dto.atom.Text Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * 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.juneau.dto.atom;

import static org.apache.juneau.xml.annotation.XmlFormat.*;

import org.apache.juneau.internal.*;
import org.apache.juneau.xml.annotation.*;

/**
 * Represents an atomTextConstruct construct in the RFC4287 specification.
 *
 * Schema
 * 
 * 	atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct
 *
 * 	atomPlainTextConstruct =
 * 		atomCommonAttributes,
 * 		attribute type { "text" | "html" }?,
 * 		text
 *
 * 	atomXHTMLTextConstruct =
 * 		atomCommonAttributes,
 * 		attribute type { "xhtml" },
 * 		xhtmlDiv
 *
 * 	xhtmlDiv = element xhtml:div {
 * 		(attribute * { text }
 * 		| text
 * 		| anyXHTML)*
 * 	}
 * 
 *
 * See Also:

 * 	Overview > juneau-dto > Atom
 * 
 */
@FluentSetters
public class Text extends Common {

	private String type;
	private String text;

	/**
	 * Normal content.
	 *
	 * @param type The content type of this content.
	 */
	public Text(String type) {
		setType(type);
	}

	/** Bean constructor. */
	public Text() {}


	//-----------------------------------------------------------------------------------------------------------------
	// Bean properties
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Bean property getter:  type.
	 *
	 * 
	 * The content type of this content.
	 *
	 * @return The property value, or null if it is not set.
	 */
	@Xml(format=ATTR)
	public String getType() {
		return type;
	}

	/**
	 * Bean property setter:  type.
	 *
	 * 

	 * The content type of this content.
	 *
	 * 

	 * Must be one of the following:
	 * 

	 * 	"text"
	 * 	
"html"
	 * 	
"xhtml"
	 * 	
null (defaults to "text")
	 * 
	 *
	 * @param value
	 * 	The new value for this property.
	 * 	
Can be null to unset the property.
	 * @return This object
	 */
	public Text setType(String value) {
		this.type = value;
		return this;
	}

	/**
	 * Bean property getter:  text.
	 *
	 * 
	 * The content of this content.
	 *
	 * @return The property value, or null if it is not set.
	 */
	@Xml(format=XMLTEXT)
	public String getText() {
		return text;
	}

	/**
	 * Bean property setter:  text.
	 *
	 * 
	 * The content of this content.
	 *
	 * @param value
	 * 	The new value for this property.
	 * 	
Can be null to unset the property.
	 * @return This object
	 */
	public Text setText(String value) {
		this.text = value;
		return this;
	}


	//-----------------------------------------------------------------------------------------------------------------
	// Overridden setters (to simplify method chaining)
	//-----------------------------------------------------------------------------------------------------------------

	// 

	@Override /* GENERATED - org.apache.juneau.dto.atom.Common */
	public Text setBase(Object value) {
		super.setBase(value);
		return this;
	}

	@Override /* GENERATED - org.apache.juneau.dto.atom.Common */
	public Text setLang(String value) {
		super.setLang(value);
		return this;
	}

	// 
}