org.eclipse.xtext.xbase.typesystem.computation

Class SynonymTypesProvider

java.lang.Object

org.eclipse.xtext.xbase.typesystem.computation.SynonymTypesProvider

public class SynonymTypesProvider
extends Object

The SynonymTypesProvider allows to define automatic conversion rules for specific types. By default, iterables are compatible to arrays, arrays are compatible to List, and boxing / unboxing semantics are applied. Clients who specialize this service, should announce synonym types by means of announceSynonym(LightweightTypeReference, ConformanceHint, Acceptor), announceSynonym(LightweightTypeReference, EnumSet, Acceptor) or announceSynonym(LightweightTypeReference, int, Acceptor). collectCustomSynonymTypes(LightweightTypeReference, Acceptor) should be implemented to announce custom synonyms. Implementations should respect the acceptor return values.

Author:

Sebastian Zarnekow - Initial contribution and API

See Also:

ArrayTypes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynonymTypesProvider.Acceptor Clients of the SynonymTypesProvider may use a custom acceptor to handle the available synonym types.

Constructor Summary

Constructors

Constructor and Description
SynonymTypesProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addArrayAndListSynonyms(LightweightTypeReference type, SynonymTypesProvider.Acceptor acceptor)
protected boolean	announceSynonym(LightweightTypeReference synonym, ConformanceHint hint, SynonymTypesProvider.Acceptor acceptor) Announce a synonym type with the given conformance hint.
protected boolean	announceSynonym(LightweightTypeReference synonym, EnumSet<ConformanceHint> hints, SynonymTypesProvider.Acceptor acceptor) Announce a synonym type with the given conformance hints.
protected boolean	announceSynonym(LightweightTypeReference synonym, int flags, SynonymTypesProvider.Acceptor acceptor) Announce a synonym type with the given conformance flags.
protected boolean	collectCustomSynonymTypes(LightweightTypeReference type, SynonymTypesProvider.Acceptor acceptor) This is the hook to announce more synonym types.
void	collectSynonymTypes(LightweightTypeReference type, SynonymTypesProvider.Acceptor acceptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

SynonymTypesProvider

public SynonymTypesProvider()

Method Detail

collectSynonymTypes

public void collectSynonymTypes(LightweightTypeReference type,
                       SynonymTypesProvider.Acceptor acceptor)

collectCustomSynonymTypes

protected boolean collectCustomSynonymTypes(LightweightTypeReference type,
                                SynonymTypesProvider.Acceptor acceptor)

This is the hook to announce more synonym types.

Parameters:

type - the original type

acceptor - the acceptor to announce the synonyms

addArrayAndListSynonyms

protected boolean addArrayAndListSynonyms(LightweightTypeReference type,
                              SynonymTypesProvider.Acceptor acceptor)

Parameters:

type - never a primitive or a wrapper type

announceSynonym

protected final boolean announceSynonym(LightweightTypeReference synonym,
                      ConformanceHint hint,
                      SynonymTypesProvider.Acceptor acceptor)

Announce a synonym type with the given conformance hint.

announceSynonym

protected final boolean announceSynonym(LightweightTypeReference synonym,
                      EnumSet<ConformanceHint> hints,
                      SynonymTypesProvider.Acceptor acceptor)

Announce a synonym type with the given conformance hints.

announceSynonym

protected final boolean announceSynonym(LightweightTypeReference synonym,
                      int flags,
                      SynonymTypesProvider.Acceptor acceptor)

Announce a synonym type with the given conformance flags.

See Also:

ConformanceFlags