Permalink
Switch branches/tags
xwiki-rendering-10.9 xwiki-rendering-10.8.1 xwiki-rendering-10.8 xwiki-rendering-10.8-rc-1 xwiki-rendering-10.7.1 xwiki-rendering-10.7 xwiki-rendering-10.7-rc-1 xwiki-rendering-10.6.1 xwiki-rendering-10.6 xwiki-rendering-10.6-rc-1 xwiki-rendering-10.5 xwiki-rendering-10.5-rc-1 xwiki-rendering-10.4 xwiki-rendering-10.4-rc-1 xwiki-rendering-10.3 xwiki-rendering-10.2 xwiki-rendering-10.1 xwiki-rendering-10.1-rc-1 xwiki-rendering-10.0 xwiki-rendering-9.11.8 xwiki-rendering-9.11.7 xwiki-rendering-9.11.6 xwiki-rendering-9.11.5 xwiki-rendering-9.11.4 xwiki-rendering-9.11.3 xwiki-rendering-9.11.2 xwiki-rendering-9.11.1 xwiki-rendering-9.11 xwiki-rendering-9.11-rc-1 xwiki-rendering-9.10.1 xwiki-rendering-9.10 xwiki-rendering-9.10-rc-1 xwiki-rendering-9.9 xwiki-rendering-9.9-rc-2 xwiki-rendering-9.8.1 xwiki-rendering-9.8 xwiki-rendering-9.8-rc-1 xwiki-rendering-9.7 xwiki-rendering-9.7-rc-1 xwiki-rendering-9.6 xwiki-rendering-9.6-rc-1 xwiki-rendering-9.5.1 xwiki-rendering-9.5 xwiki-rendering-9.5-rc-1 xwiki-rendering-9.4 xwiki-rendering-9.4-rc-1 xwiki-rendering-9.3.1 xwiki-rendering-9.3 xwiki-rendering-9.3-rc-1 xwiki-rendering-9.2 xwiki-rendering-9.2-rc-1 xwiki-rendering-9.1.2 xwiki-rendering-9.1.1 xwiki-rendering-9.1 xwiki-rendering-9.1-rc-1 xwiki-rendering-9.0 xwiki-rendering-9.0-rc-1 xwiki-rendering-8.4.6 xwiki-rendering-8.4.5 xwiki-rendering-8.4.4 xwiki-rendering-8.4.3 xwiki-rendering-8.4.2 xwiki-rendering-8.4.1 xwiki-rendering-8.4 xwiki-rendering-8.4-rc-1 xwiki-rendering-8.3 xwiki-rendering-8.3-rc-1 xwiki-rendering-8.3-milestone-2 xwiki-rendering-8.3-milestone-1 xwiki-rendering-8.2.2 xwiki-rendering-8.2.1 xwiki-rendering-8.2 xwiki-rendering-8.2-rc-1 xwiki-rendering-8.2-milestone-2 xwiki-rendering-8.2-milestone-1 xwiki-rendering-8.1 xwiki-rendering-8.1-rc-1 xwiki-rendering-8.1-milestone-2 xwiki-rendering-8.1-milestone-1 xwiki-rendering-8.0 xwiki-rendering-8.0-rc-1 xwiki-rendering-8.0-milestone-2 xwiki-rendering-8.0-milestone-1 xwiki-rendering-7.4.6 xwiki-rendering-7.4.5 xwiki-rendering-7.4.4 xwiki-rendering-7.4.3 xwiki-rendering-7.4.2 xwiki-rendering-7.4.1 xwiki-rendering-7.4 xwiki-rendering-7.4-rc-1 xwiki-rendering-7.4-milestone-2 xwiki-rendering-7.4-milestone-1 xwiki-rendering-7.3 xwiki-rendering-7.3-rc-1 xwiki-rendering-7.3-milestone-2 xwiki-rendering-7.3-milestone-1 xwiki-rendering-7.2 xwiki-rendering-7.2-rc-1 xwiki-rendering-7.2-milestone-3
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
176 lines (154 sloc) 4.68 KB
/*
* 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.listener.reference;
import org.xwiki.stability.Unstable;
/**
* The Resource type. It can be one of:
* <ul>
* <li>document ("doc")</li>
* <li>space ("space")</li>
* <li>URL ("url")</li>
* <li>document in another wiki (interwiki) ("interwiki")</li>
* <li>relative URL ("path")</li>
* <li>mail ("mailto")</li>
* <li>attachment ("attach")</li>
* <li>UNC path ("unc")</li>
* <li>User ("user")</li>
* <li>Data URI image ("data")</li>
* </ul>
*
* @version $Id$
* @since 2.5RC1
*/
public class ResourceType
{
/**
* Special type to be used when the type of the resource is not known.
*/
public static final ResourceType UNKNOWN = new ResourceType("unknown");
/**
* Represents a Document.
*/
public static final ResourceType DOCUMENT = new ResourceType("doc");
/**
* Represents a Page.
*
* @since 10.6RC1
*/
@Unstable
public static final ResourceType PAGE = new ResourceType("page");
/**
* Represents a Space.
*/
public static final ResourceType SPACE = new ResourceType("space");
/**
* Represents an URL.
*/
public static final ResourceType URL = new ResourceType("url");
/**
* Represents a document in another wiki.
*/
public static final ResourceType INTERWIKI = new ResourceType("interwiki");
/**
* Represents a relative URL in the current wiki.
*/
public static final ResourceType PATH = new ResourceType("path");
/**
* Represents a mail.
*/
public static final ResourceType MAILTO = new ResourceType("mailto");
/**
* Represents an attachment.
*/
public static final ResourceType ATTACHMENT = new ResourceType("attach");
/**
* Represents an icon.
*/
public static final ResourceType ICON = new ResourceType("icon");
/**
* Represents a UNC (Universal Naming Convention) (eg "\\myserver\myshare\mydoc.txt").
*
* @since 2.7M1
*/
public static final ResourceType UNC = new ResourceType("unc");
/**
* Represents a user.
*
* @since 5.3M2
*/
public static final ResourceType USER = new ResourceType("user");
/**
* Represents a image specified as a <a href="http://tools.ietf.org/html/rfc2397">Data URI</a>.
*
* @since 5.4RC1
*/
public static final ResourceType DATA = new ResourceType("data");
/**
* @see #getScheme()
*/
private final String scheme;
/**
* @param scheme see {@link #getScheme()}
*/
public ResourceType(String scheme)
{
this.scheme = scheme;
}
/**
* @return the type of the link (eg "doc" for links to documents, etc)
*/
public String getScheme()
{
return this.scheme;
}
@Override
public int hashCode()
{
// Random number. See http://www.technofundo.com/tech/java/equalhash.html for the detail of this
// algorithm.
int hash = 8;
hash = 31 * hash + (null == getScheme() ? 0 : getScheme().hashCode());
return hash;
}
@Override
public boolean equals(Object object)
{
boolean result;
// See http://www.technofundo.com/tech/java/equalhash.html for the detail of this algorithm.
if (this == object) {
result = true;
} else {
if ((object == null) || (object.getClass() != this.getClass())) {
result = false;
} else {
// object must be ResourceType at this point
ResourceType type = (ResourceType) object;
result =
getScheme() == type.getScheme() || (getScheme() != null && getScheme().equals(type.getScheme()));
}
}
return result;
}
@Override
public String toString()
{
return getScheme();
}
}