QualifiedName (Xtext Runtime Bundle 2.9.2 API)

java.lang.Object
- org.eclipse.xtext.naming.QualifiedName

All Implemented Interfaces:

Comparable<QualifiedName>
```
public class QualifiedName
extends Object
implements Comparable<QualifiedName>
```
A datatype for dealing with qualified names. Instances are usually provided by a IQualifiedNameProvider.

Author:

Jan Koehnlein - Initial contribution and API, Sebastian Zarnekow

Field Summary

Fields
Modifier and Type Field and Description

static QualifiedName EMPTY

Fields
Modifier and Type	Field and Description
`static QualifiedName`	`EMPTY`

Constructor Summary

Constructors
Modifier Constructor and Description

protected QualifiedName(String... segments)

Constructors
Modifier	Constructor and Description
`protected`	`QualifiedName(String... segments)`

Method Summary

Methods
Modifier and Type	Method and Description
`QualifiedName`	`append(QualifiedName relativeQualifiedName)`
`QualifiedName`	`append(String segment)`
`int`	`compareTo(QualifiedName qualifiedName)`
`protected int`	`compareTo(QualifiedName qualifiedName, boolean ignoreCase)`
`int`	`compareToIgnoreCase(QualifiedName qualifiedName)`
`static QualifiedName`	`create(List<String> segments)` Low-level factory method.
`static QualifiedName`	`create(String... segments)` Low-level factory method.
`static QualifiedName`	`create(String singleSegment)` Low-level factory method.
`static QualifiedName`	`createFromStream(org.eclipse.emf.ecore.resource.impl.BinaryResourceImpl.EObjectInputStream eObjectInputStream)` Internal low level factory method.
`boolean`	`equals(Object obj)`
`boolean`	`equalsIgnoreCase(Object obj)`
`String`	`getFirstSegment()`
`String`	`getLastSegment()`
`String`	`getSegment(int index)`
`int`	`getSegmentCount()`
`List<String>`	`getSegments()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`QualifiedName`	`skipFirst(int skipCount)`
`QualifiedName`	`skipLast(int skipCount)`
`boolean`	`startsWith(QualifiedName prefix)`
`protected boolean`	`startsWith(QualifiedName prefix, boolean ignoreCase)`
`boolean`	`startsWithIgnoreCase(QualifiedName prefix)`
`QualifiedName`	`toLowerCase()`
`String`	`toString()` Returns a canonical String representation of this using '.' as namespace delimiter.
`String`	`toString(String delimiter)` Returns a String representation of this using `delimiter` as namespace delimiter.
`QualifiedName`	`toUpperCase()`
`static <F> com.google.common.base.Function<F,QualifiedName>`	`wrapper(com.google.common.base.Function<F,String> nameFunction)` Wraps a name function to return a qualified name.
`void`	`writeToStream(org.eclipse.emf.ecore.resource.impl.BinaryResourceImpl.EObjectOutputStream eObjectOutputStream)` Internal low level serialization of QualifiedNames.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final QualifiedName EMPTY
```
- Constructor Detail
  - QualifiedName
```
protected QualifiedName(String... segments)
```
- Method Detail
  - create
```
public static QualifiedName create(String... segments)
```
    Low-level factory method. Consider using a IQualifiedNameConverter instead.
    
    Parameters:
    segments - the segments of the to-be-created qualified name. May be null, but may not contain null entries.
    
    Returns:
    a QualifiedName. Never null.
    
    Throws:
    
    IllegalArgumentException - if any of the segments is null
  - createFromStream
```
public static QualifiedName createFromStream(org.eclipse.emf.ecore.resource.impl.BinaryResourceImpl.EObjectInputStream eObjectInputStream)
                                      throws IOException
```
    Internal low level factory method.
    
    Throws:
    
    IOException
    Since:
    
    2.4
  - writeToStream
```
public void writeToStream(org.eclipse.emf.ecore.resource.impl.BinaryResourceImpl.EObjectOutputStream eObjectOutputStream)
                   throws IOException
```
    Internal low level serialization of QualifiedNames.
    
    Throws:
    
    IOException
    Since:
    
    2.4
  - create
```
public static QualifiedName create(List<String> segments)
```
    Low-level factory method. Consider using a IQualifiedNameConverter instead.
    
    Parameters:
    segments - the segments of the to-be-created qualified name. May be null, but may not contain null entries.
    
    Returns:
    a QualifiedName. Never null.
    
    Throws:
    
    IllegalArgumentException - if any of the segments is null
    Since:
    
    2.3
  - create
```
public static QualifiedName create(String singleSegment)
```
    Low-level factory method. Consider using a IQualifiedNameConverter instead.
    
    Parameters:
    singleSegment - the single segment of the newly created qualified name
    
    Throws:
    
    IllegalArgumentException - if the singleSegment is null
    Since:
    
    2.3
  - wrapper
```
public static <F> com.google.common.base.Function<F,QualifiedName> wrapper(com.google.common.base.Function<F,String> nameFunction)
```
    Wraps a name function to return a qualified name. Returns null if the name function returns null.
  - isEmpty
```
public boolean isEmpty()
```
  - getSegments
```
public List<String> getSegments()
```
  - getSegmentCount
```
public int getSegmentCount()
```
  - getSegment
```
public String getSegment(int index)
```
  - getLastSegment
```
public String getLastSegment()
```
  - getFirstSegment
```
public String getFirstSegment()
```
  - append
```
public QualifiedName append(String segment)
```
  - append
```
public QualifiedName append(QualifiedName relativeQualifiedName)
```
  - skipFirst
```
public QualifiedName skipFirst(int skipCount)
```
  - skipLast
```
public QualifiedName skipLast(int skipCount)
```
  - toLowerCase
```
public QualifiedName toLowerCase()
```
  - toUpperCase
```
public QualifiedName toUpperCase()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(Object obj)
```
  - compareTo
```
public int compareTo(QualifiedName qualifiedName)
```
    Specified by:
    
    compareTo in interface Comparable<QualifiedName>
  - compareToIgnoreCase
```
public int compareToIgnoreCase(QualifiedName qualifiedName)
```
  - compareTo
```
protected int compareTo(QualifiedName qualifiedName,
            boolean ignoreCase)
```
  - startsWith
```
public boolean startsWith(QualifiedName prefix)
```
  - startsWithIgnoreCase
```
public boolean startsWithIgnoreCase(QualifiedName prefix)
```
  - startsWith
```
protected boolean startsWith(QualifiedName prefix,
                 boolean ignoreCase)
```
  - toString
```
public String toString()
```
    Returns a canonical String representation of this using '.' as namespace delimiter. For language specific conversion taking the concrete syntax into account see IQualifiedNameConverter.toString(QualifiedName).
    
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(String delimiter)
```
    Returns a String representation of this using delimiter as namespace delimiter.
    
    Parameters:
    delimiter - the delimiter to use. null will be represented as the String "null".
    
    Returns:
    the concatenated segments joined with the given delimiter
    Since:
    
    2.3

Class QualifiedName

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

QualifiedName

Method Detail

create

createFromStream

writeToStream

create

create

wrapper

isEmpty

getSegments

getSegmentCount

getSegment

getLastSegment

getFirstSegment

append

append

skipFirst

skipLast

toLowerCase

toUpperCase

hashCode

equals

equalsIgnoreCase

compareTo

compareToIgnoreCase

compareTo

startsWith

startsWithIgnoreCase

startsWith

toString

toString