org.jboss.forge.roaster.model.source

Interface Importer<O extends JavaSource<O>>

All Known Subinterfaces:

EnumConstantSource.Body, JavaAnnotationSource, JavaClassSource, JavaEnumSource, JavaInterfaceSource, JavaPackageInfoSource, JavaSource<T>

public interface Importer<O extends JavaSource<O>>

Defines the aspect of JavaSource that handles type imports.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
Import	addImport(Class<?> type) Add an import for the given Class type.
Import	addImport(Import imprt) Add an import for the given Import type.
Import	addImport(String className) Add an import by qualified class name.
<T extends JavaType<?>> Import	addImport(T type) Add an import for the given JavaType type.
Import	addImport(Type<?> type) Ensures the type passed as argument is included in the list of imports for this java source.
Import	getImport(Class<?> type) Get the Import for the given Class type, if it exists; otherwise, return null;
Import	getImport(Import imprt) Get the Import of the given Import type, if it exists; otherwise, return null;
Import	getImport(String literalValue) Get the Import for the given fully-qualified class name, if it exists; otherwise, return null;
<T extends JavaType<?>> Import	getImport(T type) Get the Import for the given T type, if it exists; otherwise, return null;
List<Import>	getImports() Get an immutable list of all Imports currently imported by this O
boolean	hasImport(Class<?> type) Return whether or not this O has an import for the given Class type.
boolean	hasImport(Import imprt) Return whether or not this O has the given Import type.
boolean	hasImport(String type) Return whether or not this O has an import for the given fully-qualified class name.
<T extends JavaType<T>> boolean	hasImport(T type) Return whether or not this O has an import for the given T type.
O	removeImport(Class<?> type) Remove any Import for the given Class type, if it exists; otherwise, do nothing;
O	removeImport(Import imprt) Remove the given Import from this O instance, if it exists; otherwise, do nothing;
O	removeImport(String name) Remove any Import for the given fully-qualified class name, if it exists; otherwise, do nothing;
<T extends JavaType<?>> O	removeImport(T type) Remove any Import for the given T type, if it exists; otherwise, do nothing;
boolean	requiresImport(Class<?> type) Return whether or not this O would require an import to reference the given Class type.
boolean	requiresImport(String type) Return whether or not this O would require an import to reference the given fully-qualified class name.
String	resolveType(String type) Given a simple or qualified type, resolve that type against the available imports and return the referenced type.

Method Detail

hasImport

boolean hasImport(Class<?> type)

Return whether or not this O has an import for the given Class type.

hasImport

boolean hasImport(String type)

Return whether or not this O has an import for the given fully-qualified class name.

requiresImport

boolean requiresImport(Class<?> type)

Return whether or not this O would require an import to reference the given Class type.

requiresImport

boolean requiresImport(String type)

Return whether or not this O would require an import to reference the given fully-qualified class name.

hasImport

<T extends JavaType<T>> boolean hasImport(T type)

Return whether or not this O has an import for the given T type.

hasImport

boolean hasImport(Import imprt)

Return whether or not this O has the given Import type.

getImport

Import getImport(String literalValue)

Get the Import for the given fully-qualified class name, if it exists; otherwise, return null;

getImport

Import getImport(Class<?> type)

Get the Import for the given Class type, if it exists; otherwise, return null;

getImport

<T extends JavaType<?>> Import getImport(T type)

Get the Import for the given T type, if it exists; otherwise, return null;

getImport

Import getImport(Import imprt)

Get the Import of the given Import type, if it exists; otherwise, return null;

getImports

List<Import> getImports()

Get an immutable list of all Imports currently imported by this O

resolveType

String resolveType(String type)

Given a simple or qualified type, resolve that type against the available imports and return the referenced type. If the type cannot be resolved, return the given type unchanged.

addImport

Import addImport(String className)

Add an import by qualified class name. (E.g: "com.example.Imported") unless it is in the provided 'java.lang.*' package.

addImport

Import addImport(Class<?> type)

Add an import for the given Class type.

addImport

Import addImport(Import imprt)

Add an import for the given Import type.

addImport

<T extends JavaType<?>> Import addImport(T type)

Add an import for the given JavaType type.

addImport

Import addImport(Type<?> type)

Ensures the type passed as argument is included in the list of imports for this java source. The method will also recursively import parameter types. This method is idempotent: if a type has already been imported, no further action will be required. The method returns the name that can be used inside the code to reference the type. The name will be simple if no ambiguity exists with other types having the same (local) name, or fully qualified otherwise.

Parameters:

type - The Type to be imported.

Returns:

The name (simple or fully qualified) that should be used to reference the imported type in the code

removeImport

O removeImport(String name)

Remove any Import for the given fully-qualified class name, if it exists; otherwise, do nothing;

removeImport

O removeImport(Class<?> type)

Remove any Import for the given Class type, if it exists; otherwise, do nothing;

removeImport

<T extends JavaType<?>> O removeImport(T type)

Remove any Import for the given T type, if it exists; otherwise, do nothing;

removeImport

O removeImport(Import imprt)

Remove the given Import from this O instance, if it exists; otherwise, do nothing;