org.apache.wicket.markup.RawMarkup Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wicket-core Show documentation

Wicket is a Java web application framework that takes simplicity, separation of concerns and ease of development to a whole new level. Wicket pages can be mocked up, previewed and later revised using standard WYSIWYG HTML design tools. Dynamic content processing and form handling is all handled in Java code using a first-class component model backed by POJO data beans that can easily be persisted using your favorite technology.

There is a newer version: 10.0.0

Show newest version

/*
 * 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.wicket.markup;

/**
 * This class is for framework purposes only, which is why the class is (default) protected.
 * 
 * A RawMarkup element represents a hunk of unparsed HTML containing any arbitrary content.
 * 
 * @see MarkupElement
 * @author Jonathan Locke
 */
public class RawMarkup extends MarkupElement
{
	/** The raw markup string * */
	private final CharSequence string;

	/**
	 * Create a RawMarkup element referencing an uninterpreted markup string.
	 * 
	 * @param string
	 *            The raw markup
	 */
	public RawMarkup(final CharSequence string)
	{
		this.string = string;
	}

	/**
	 * Compare with a given object
	 * 
	 * @param o
	 *            The object to compare with
	 * @return True if equal
	 */
	@Override
	public boolean equals(final Object o)
	{
		if (o instanceof CharSequence)
		{
			return string.equals(o);
		}

		if (o instanceof RawMarkup)
		{
			return string.equals(((RawMarkup)o).string);
		}

		return false;
	}

	/**
	 * @see org.apache.wicket.markup.MarkupElement#equalTo(org.apache.wicket.markup.MarkupElement)
	 */
	@Override
	public boolean equalTo(final MarkupElement element)
	{
		if (element instanceof RawMarkup)
		{
			return toString().equals(element.toString());
		}
		return false;
	}

	/**
	 * We must override hashCode since we overrode equals.
	 * 
	 * @return Hashcode for this object
	 */
	@Override
	public int hashCode()
	{
		return string.hashCode();
	}

	/**
	 * @see org.apache.wicket.markup.MarkupElement#toCharSequence()
	 */
	@Override
	public CharSequence toCharSequence()
	{
		return string;
	}

	/**
	 * @return This raw markup string
	 */
	@Override
	public String toString()
	{
		return string.toString();
	}

	/**
	 * @see MarkupElement#toUserDebugString()
	 */
	@Override
	public String toUserDebugString()
	{
		return "[Raw markup]";
	}
}