io.guise.framework.model.TextModel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed 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 io.guise.framework.model;

import com.globalmentor.net.MediaType;

import static com.globalmentor.java.Classes.*;

/**
 * A model for text and an associated label. This model only supports text content types, including:
 * 
 * text/*
 * application/xml
 * application/*+xml
 * 
 * 
 * The model defaults to a content type of text/plain.
 * 
 * @author Garret Wilson
 */
public interface TextModel extends Model {

	/** The text content type bound property. */
	public static final String TEXT_CONTENT_TYPE_PROPERTY = getPropertyName(TextModel.class, "contentType");
	/** The text bound property. */
	public static final String TEXT_PROPERTY = getPropertyName(TextModel.class, "text");

	/** @return The text, which may include a resource reference, or null if there is no text. */
	public String getText();

	/**
	 * Sets the text. This is a bound property.
	 * @param newText The new text, which may include a resource reference.
	 * @see #TEXT_PROPERTY
	 */
	public void setText(final String newText);

	/** @return The content type of the text. */
	public MediaType getTextContentType();

	/**
	 * Sets the content type of the text. This is a bound property.
	 * @param newTextContentType The new text content type.
	 * @throws NullPointerException if the given content type is null.
	 * @throws IllegalArgumentException if the given content type is not a text content type.
	 * @see #TEXT_CONTENT_TYPE_PROPERTY
	 */
	public void setTextContentType(final MediaType newTextContentType);
}