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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.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 final 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 String)
		{
			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]";
	}
}