org.xwiki.rendering.block.SpaceBlock Maven / Gradle / Ivy
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.rendering.block;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.xwiki.rendering.listener.Listener;
/**
* A space block represents a space. Note that we don't make SpaceBlock a singleton since that would cause problems when
* using Block APIs to manipulate a tree of blocks (for example to find the position of a space block in a list using
* {@link java.util.List#indexOf(Object)} which would always return the first space block).
*
* @version $Id: 65be13be5783203307f3762e91e258926d700df1 $
* @since 1.5M2
*/
public final class SpaceBlock extends AbstractBlock
{
@Override
public void traverse(Listener listener)
{
listener.onSpace();
}
@Override
public String toString()
{
return " ";
}
@Override
public boolean equals(Object obj)
{
return obj instanceof SpaceBlock && super.equals(obj);
}
@Override
public int hashCode()
{
HashCodeBuilder builder = new HashCodeBuilder();
builder.appendSuper(super.hashCode());
builder.append(SpaceBlock.class);
return builder.toHashCode();
}
}