org.xwiki.rendering.parser
Interface ResourceReferenceTypeParser

All Known Implementing Classes:
AbstractURIResourceReferenceTypeParser, AttachmentResourceReferenceTypeParser, DocumentResourceReferenceTypeParser, ExtensionResourceReferenceTypeParser, IconResourceReferenceTypeParser, InterWikiResourceReferenceTypeParser, MailtoResourceReferenceTypeParser, PathResourceReferenceTypeParser, UNCResourceReferenceTypeParser, URLResourceReferenceTypeParser

@Role
public interface ResourceReferenceTypeParser

Parses a raw Resource Reference by determining if it has the right type and return a non-null ResourceReference object if it has.

Since:
2.5RC1

Method Summary
 ResourceType getType()
           
 ResourceReference parse(String reference)
           
 

Method Detail

getType

ResourceType getType()
Returns:
the resource type (document, url, attachment, etc).

parse

ResourceReference parse(String reference)
Parameters:
reference - the raw resource reference to parse
Returns:
the parsed resource information if the passed reference can be parsed by this type parser or null if the passed reference isn't valid