org.eclipse.ocl.pivot.internal.prettyprint

Class PrettyPrintOptions

java.lang.Object

org.eclipse.ocl.pivot.internal.prettyprint.PrettyPrintOptions

Direct Known Subclasses:

PrettyPrintOptions.Global, PrettyPrintOptions.Local

public abstract class PrettyPrintOptions
extends java.lang.Object

PrettyPrintOptions defines the capability to provide options to the PrettyPrinter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrettyPrintOptions.Global Global PrettyPrintOptions apply regardless of pretty printer nesting.
static class	PrettyPrintOptions.Local Local PrettyPrintOptions may be overridden in nested pretty printer contexts.

Field Summary

Fields

Modifier and Type	Field and Description
protected Namespace	scope

Constructor Summary

Constructors

Constructor and Description
PrettyPrintOptions(Namespace scope)

Method Summary

Modifier and Type	Method and Description
abstract void	addReservedNames(java.lang.Iterable<java.lang.String> names)
abstract void	addRestrictedNames(java.lang.Iterable<java.lang.String> names)
java.lang.String	getAlias(Namespace namespace) Return a name to be used when referencing element as the first element in a qualified name.
org.eclipse.emf.common.util.URI	getBaseURI() Return a URI against which to deresolve the first element of qualified names that reference external resources.
EnvironmentFactory	getEnvironmentFactory()
abstract PrettyPrintOptions.Global	getGlobalOptions()
java.lang.String	getIndentStep()
int	getLinelength()
abstract java.util.Set<java.lang.String>	getReservedNames()
abstract java.util.Set<java.lang.String>	getRestrictedNames()
Namespace	getScope()
void	setIndentStep(java.lang.String indentStep)
void	setLinelength(int linelength)

Methods inherited from class java.lang.Object

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

Field Detail

scope

@Nullable
protected final Namespace scope

Constructor Detail

PrettyPrintOptions

public PrettyPrintOptions(@Nullable
                          Namespace scope)

Method Detail

addReservedNames

public abstract void addReservedNames(@NonNull
                                      java.lang.Iterable<java.lang.String> names)

addRestrictedNames

public abstract void addRestrictedNames(@NonNull
                                        java.lang.Iterable<java.lang.String> names)

getAlias

@Nullable
public java.lang.String getAlias(@NonNull
                                            Namespace namespace)

Return a name to be used when referencing element as the first element in a qualified name.

getBaseURI

@Nullable
public org.eclipse.emf.common.util.URI getBaseURI()

Return a URI against which to deresolve the first element of qualified names that reference external resources. Null leaves URIs in global form.

getEnvironmentFactory

@Nullable
public EnvironmentFactory getEnvironmentFactory()

getGlobalOptions

@NonNull
public abstract PrettyPrintOptions.Global getGlobalOptions()

getIndentStep

@NonNull
public java.lang.String getIndentStep()

getLinelength

public int getLinelength()

getReservedNames

@Nullable
public abstract java.util.Set<java.lang.String> getReservedNames()

getRestrictedNames

@Nullable
public abstract java.util.Set<java.lang.String> getRestrictedNames()

getScope

@Nullable
public Namespace getScope()

setIndentStep

public void setIndentStep(@NonNull
                          java.lang.String indentStep)

setLinelength

public void setLinelength(int linelength)