org.eclipse.xtext.linking.lazy

Class LazyURIEncoder

java.lang.Object

org.eclipse.xtext.linking.lazy.LazyURIEncoder

public class LazyURIEncoder
extends Object

Author:

Sven Efftinge - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEP
static String	USE_INDEXED_FRAGMENTS_BINDING
static String	XTEXT_LINK

Constructor Summary

Constructors

Constructor and Description
LazyURIEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	appendShortFragment(org.eclipse.emf.ecore.EObject obj, StringBuilder target)
Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>	decode(org.eclipse.emf.ecore.resource.Resource res, String uriFragment) decodes the uriFragment
String	encode(org.eclipse.emf.ecore.EObject obj, org.eclipse.emf.ecore.EReference ref, INode node) encodes the given three parameters into a string, so that they can be retrieved from a resource using decode(Resource, String)
org.eclipse.emf.ecore.EReference	fromShortExternalForm(org.eclipse.emf.ecore.EClass clazz, String shortForm)
int	getIndex(String uriFragment)
protected String	getIndexFragment(org.eclipse.emf.ecore.EObject obj, org.eclipse.emf.ecore.EReference ref, INode node)
protected Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>	getLazyProxyInformation(org.eclipse.emf.ecore.resource.Resource res, String uriFragment)
INode	getNode(org.eclipse.emf.ecore.EObject object, String fragment)
INode	getNode(INode node, String path) ONLY public to be testable
void	getRelativePath(StringBuilder result, INode parserNode, INode node) ONLY public to be testable
protected boolean	isAncestor(INode parent, INode child)
boolean	isCrossLinkFragment(org.eclipse.emf.ecore.resource.Resource res, String s)
boolean	isUseIndexFragment(org.eclipse.emf.ecore.resource.Resource context)
org.eclipse.emf.ecore.EObject	resolveShortFragment(org.eclipse.emf.ecore.resource.Resource res, String shortFragment)
String	toShortExternalForm(org.eclipse.emf.ecore.EClass clazz, org.eclipse.emf.ecore.EReference ref)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XTEXT_LINK

public static final String XTEXT_LINK

Since:

2.3 deprecated use isCrossLinkFragment(Resource, String) instead

See Also:

Constant Field Values

SEP

public static final String SEP

Since:

2.3

See Also:

Constant Field Values

USE_INDEXED_FRAGMENTS_BINDING

public static final String USE_INDEXED_FRAGMENTS_BINDING

Since:

2.7

See Also:

Constant Field Values

Constructor Detail

LazyURIEncoder

public LazyURIEncoder()

Method Detail

isUseIndexFragment

public boolean isUseIndexFragment(org.eclipse.emf.ecore.resource.Resource context)

Since:

2.7

encode

public String encode(org.eclipse.emf.ecore.EObject obj,
            org.eclipse.emf.ecore.EReference ref,
            INode node)

encodes the given three parameters into a string, so that they can be retrieved from a resource using decode(Resource, String)

Parameters:

obj - the feature holder

ref - the cross reference

node - the node that provided the value for the reference

Returns:

a portable string that may be used as a fragment

getIndexFragment

protected String getIndexFragment(org.eclipse.emf.ecore.EObject obj,
                      org.eclipse.emf.ecore.EReference ref,
                      INode node)

Since:

2.7

appendShortFragment

public void appendShortFragment(org.eclipse.emf.ecore.EObject obj,
                       StringBuilder target)

toShortExternalForm

public String toShortExternalForm(org.eclipse.emf.ecore.EClass clazz,
                         org.eclipse.emf.ecore.EReference ref)

decode

public Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> decode(org.eclipse.emf.ecore.resource.Resource res,
                                                                                  String uriFragment)

decodes the uriFragment

Parameters:

res - the resource that contains the feature holder

uriFragment - the fragment that should be decoded

Returns:

the decoded information

See Also:

encode(EObject, EReference, INode)

getLazyProxyInformation

protected Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> getLazyProxyInformation(org.eclipse.emf.ecore.resource.Resource res,
                                                                                                   String uriFragment)

Since:

2.7

getIndex

public int getIndex(String uriFragment)

Since:

2.7

resolveShortFragment

public org.eclipse.emf.ecore.EObject resolveShortFragment(org.eclipse.emf.ecore.resource.Resource res,
                                                 String shortFragment)

fromShortExternalForm

public org.eclipse.emf.ecore.EReference fromShortExternalForm(org.eclipse.emf.ecore.EClass clazz,
                                                     String shortForm)

getRelativePath

public void getRelativePath(StringBuilder result,
                   INode parserNode,
                   INode node)

ONLY public to be testable

isAncestor

protected boolean isAncestor(INode parent,
                 INode child)

getNode

public INode getNode(org.eclipse.emf.ecore.EObject object,
            String fragment)

Since:

2.4

getNode

public INode getNode(INode node,
            String path)

ONLY public to be testable

isCrossLinkFragment

public boolean isCrossLinkFragment(org.eclipse.emf.ecore.resource.Resource res,
                          String s)