codebases.frontend

Interface CodebaseSource

All Known Implementing Classes:

DerivedLocalSource, LocalSource, PublishedLocalSource, RemoteSource

public interface CodebaseSource

Method Summary

Modifier and Type	Method and Description
java.net.URI	canonicalNamespace() The canonical namespace of source is the namespace its dependencies are resolved in.
void	close() Close the source file.
Source	derivedSource(java.lang.String name) Some compiler jobs are dynamically generated during compiling a resource, but are not directly stored in the resource.
Label	label() The label of this source file.
java.lang.String	name() The short name of this source (i.e.
java.net.URI	namespace() The namespace loading this source.
java.io.Reader	open() Open the source file.
Source	publishedSource(java.net.URI namespace, java.lang.String name) Create a derived source object with a new namespace and short name.
void	setPublish(boolean pub)
boolean	shouldPublish() Whether a new class object should be published for this source file and associated with the codebase representing the namespace.

Method Detail

namespace

java.net.URI namespace()

The namespace loading this source.

name

java.lang.String name()

The short name of this source (i.e. its filename).

Returns:

canonicalNamespace

java.net.URI canonicalNamespace()

The canonical namespace of source is the namespace its dependencies are resolved in.

Returns:

The canonical namespace of this source

derivedSource

Source derivedSource(java.lang.String name)

Some compiler jobs are dynamically generated during compiling a resource, but are not directly stored in the resource. For instance when a Fabric interface is translated to FabIL, the compiler generates a *_JIF_IMPL class that implements instanceof for that interface, among other things. To ensure flexible handling between phases, we create a 'derived' source that is backed by the link to the original resource, but permits a new job to be scheduled.

Parameters:

name -

Returns:

A source derived from this CodebaseSource with a new (short) name

publishedSource

Source publishedSource(java.net.URI namespace,
                       java.lang.String name)

Create a derived source object with a new namespace and short name.

Parameters:

namespace -

name -

Returns:

shouldPublish

boolean shouldPublish()

Whether a new class object should be published for this source file and associated with the codebase representing the namespace.

Returns:

label

Label label()

The label of this source file.

open

java.io.Reader open()
             throws java.io.IOException

Open the source file.

Throws:

java.io.IOException

close

void close()
    throws java.io.IOException

Close the source file.

Throws:

java.io.IOException

setPublish

void setPublish(boolean pub)