org.xwiki.rendering.macro.source.MacroContentSourceReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-transformation-macro Show documentation
XWiki Rendering - Transformation - Macro
The newest version!
/*
 * 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.macro.source;

import java.util.Objects;

import org.apache.commons.lang3.builder.HashCodeBuilder;

/**
 * The reference of a wiki content to use as macro content.
 * 
 * @version $Id: 2fc816237418fc3b751a6604acbc900aa9720a62 $
 * @since 15.1RC1
 * @since 14.10.5
 */
public class MacroContentSourceReference
{
    /**
     * The type to use for a reference which contain the actual content.
     */
    public static final String TYPE_STRING = "string";

    /**
     * The type to use for a reference targeting a script context entry.
     */
    public static final String TYPE_SCRIPT = "script";

    /**
     * The type to use for a reference targeting a URL.
     */
    public static final String TYPE_URL = "url";

    /**
     * The type to use for a reference targeting a local file.
     */
    public static final String TYPE_FILE = "file";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized entity reference
     * (including the entity type).
     */
    public static final String TYPE_ENTITY = "entity";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized document
     * reference.
     */
    public static final String TYPE_DOCUMENT = "document";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized page reference.
     */
    public static final String TYPE_PAGE = "page";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized document object
     * property reference.
     */
    public static final String TYPE_OBJECT_PROPERTY = "object_property";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized page object
     * property reference.
     */
    public static final String TYPE_PAGE_OBJECT_PROPERTY = "page_object_property";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized page reference.
     */
    public static final String TYPE_ATTACHMENT = "attachment";

    /**
     * The type to use for a reference targeting an XWiki model entity, the reference is a serialized page reference.
     */
    public static final String TYPE_PAGE_ATTACHMENT = "page_attachment";

    private final String type;

    private final String reference;

    /**
     * @param type the type of the content
     * @param reference the reference of the content
     */
    public MacroContentSourceReference(String type, String reference)
    {
        this.type = type;
        this.reference = reference;
    }

    /**
     * @return the type of the content
     */
    public String getType()
    {
        return this.type;
    }

    /**
     * @return the reference of the content
     */
    public String getReference()
    {
        return this.reference;
    }

    @Override
    public String toString()
    {
        return getType() + ':' + getReference();
    }

    @Override
    public boolean equals(Object obj)
    {
        if (obj != null) {
            if (obj == this) {
                return true;
            }

            if (obj instanceof MacroContentSourceReference) {
                MacroContentSourceReference otherSource = (MacroContentSourceReference) obj;

                return Objects.equals(getType(), otherSource.getType())
                    && Objects.equals(getReference(), otherSource.getReference());
            }
        }

        return false;
    }

    @Override
    public int hashCode()
    {
        HashCodeBuilder builder = new HashCodeBuilder();

        builder.append(getType());
        builder.append(getReference());

        return builder.build();
    }
}