codebases.frontend

Class RemoteSource

java.lang.Object

UTF8FileSource

codebases.frontend.RemoteSource

All Implemented Interfaces:

CodebaseSource

public class RemoteSource
extends UTF8FileSource
implements CodebaseSource

Field Summary

Fields

Modifier and Type	Field and Description
protected FClass	fcls
protected java.net.URI	namespace
protected boolean	publish
protected java.io.Reader	reader

Constructor Summary

Constructors

Constructor and Description
RemoteSource(javax.tools.FileObject fo, FClass fcls, Kind kind)
RemoteSource(javax.tools.FileObject fo, FClass fcls, Kind kind, boolean publish)

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.
boolean	equals(java.lang.Object o) Sources are equal to each other if they refer to the same resource.
int	hashCode()
Label	label() The label of this source file.
java.net.URI	namespace() The namespace loading this source.
java.io.Reader	open() Open the source file.
java.lang.String	path()
Source	publishedSource(java.net.URI ns, 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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface codebases.frontend.CodebaseSource

name

Field Detail

namespace

protected final java.net.URI namespace

fcls

protected final FClass fcls

publish

protected boolean publish

reader

protected java.io.Reader reader

Constructor Detail

RemoteSource

public RemoteSource(javax.tools.FileObject fo,
                    FClass fcls,
                    Kind kind)
             throws java.io.IOException

Throws:

java.io.IOException

RemoteSource

public RemoteSource(javax.tools.FileObject fo,
                    FClass fcls,
                    Kind kind,
                    boolean publish)
             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

shouldPublish

public boolean shouldPublish()

Description copied from interface: CodebaseSource

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

Specified by:

shouldPublish in interface CodebaseSource

Returns:

close

public void close()
           throws java.io.IOException

Description copied from interface: CodebaseSource

Close the source file.

Specified by:

close in interface CodebaseSource

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Sources are equal to each other if they refer to the same resource.

hashCode

public int hashCode()

namespace

public java.net.URI namespace()

Description copied from interface: CodebaseSource

The namespace loading this source.

Specified by:

namespace in interface CodebaseSource

canonicalNamespace

public java.net.URI canonicalNamespace()

Description copied from interface: CodebaseSource

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

Specified by:

canonicalNamespace in interface CodebaseSource

Returns:

The canonical namespace of this source

derivedSource

public Source derivedSource(java.lang.String name)

Description copied from interface: CodebaseSource

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.

Specified by:

derivedSource in interface CodebaseSource

Returns:

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

publishedSource

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

Description copied from interface: CodebaseSource

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

Specified by:

publishedSource in interface CodebaseSource

Returns:

label

public Label label()

Description copied from interface: CodebaseSource

The label of this source file.

Specified by:

label in interface CodebaseSource

setPublish

public void setPublish(boolean pub)

Specified by:

setPublish in interface CodebaseSource

open

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

Description copied from interface: CodebaseSource

Open the source file.

Specified by:

open in interface CodebaseSource

Throws:

java.io.IOException

path

public java.lang.String path()

toString

public java.lang.String toString()