org.sandev.generator
Class SandFieldType

java.lang.Object
  org.sandev.generator.SandFieldType

All Implemented Interfaces:

com.sun.javadoc.Type

public class SandFieldType
extends java.lang.Object
implements com.sun.javadoc.Type

Basic Type implementation used for adding synthesized fields to an existing FieldDoc. It would be nice to use whatever Sun uses; since they don't provide access to the Type used by the Standard Doclet, we roll our own. Note that this implementation is designed only to support synthesized fields for doclets; as a result, some functionality of the Type API is not implemented.

Field Summary

protected java.lang.String	dimension
protected java.lang.String	qualifier
protected java.lang.String	typeName

Constructor Summary

SandFieldType(java.lang.String dimension, java.lang.String qualifier, java.lang.String typeName)

Method Summary

com.sun.javadoc.AnnotationTypeDoc	asAnnotationTypeDoc() Returns null.
com.sun.javadoc.ClassDoc	asClassDoc() Not implemented; returns null.
com.sun.javadoc.ParameterizedType	asParameterizedType() Returns null.
com.sun.javadoc.TypeVariable	asTypeVariable() Returns null.
com.sun.javadoc.WildcardType	asWildcardType() Returns null.
java.lang.String	dimension()
boolean	isPrimitive() Returns false.
java.lang.String	qualifiedTypeName()
java.lang.String	simpleTypeName() Returns typeName.
java.lang.String	toString()
java.lang.String	typeName()

Methods inherited from class java.lang.Object

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

Field Detail

dimension

protected java.lang.String dimension

qualifier

protected java.lang.String qualifier

typeName

protected java.lang.String typeName

Constructor Detail

SandFieldType

public SandFieldType(java.lang.String dimension,
                     java.lang.String qualifier,
                     java.lang.String typeName)

Parameters:

qualifier - The package of the Type, up to and including the final dot. For example, the qualifier for java.lang.String is "java.lang.".

Method Detail

asClassDoc

public com.sun.javadoc.ClassDoc asClassDoc()

Not implemented; returns null.

Specified by:

asClassDoc in interface com.sun.javadoc.Type

dimension

public java.lang.String dimension()

Specified by:

dimension in interface com.sun.javadoc.Type

qualifiedTypeName

public java.lang.String qualifiedTypeName()

Specified by:

qualifiedTypeName in interface com.sun.javadoc.Type

toString

public java.lang.String toString()

Specified by:

toString in interface com.sun.javadoc.Type

Overrides:

toString in class java.lang.Object

typeName

public java.lang.String typeName()

Specified by:

typeName in interface com.sun.javadoc.Type

asAnnotationTypeDoc

public com.sun.javadoc.AnnotationTypeDoc asAnnotationTypeDoc()

Returns null. Required in 1.5 and kills 1.4 compilation since this is new. Simplest workaround for 1.4 is probably to create AnnotationTypeDoc.java with package com.sun.javadoc and an empty class declaration in this local directory.

Specified by:

asAnnotationTypeDoc in interface com.sun.javadoc.Type

asWildcardType

public com.sun.javadoc.WildcardType asWildcardType()

Returns null. Required in 1.5 and kills 1.4 compilation since this is new. Simplest workaround for 1.4 is probably to create WildcardType.java with package com.sun.javadoc and an empty class declaration in this local directory.

Specified by:

asWildcardType in interface com.sun.javadoc.Type

asTypeVariable

public com.sun.javadoc.TypeVariable asTypeVariable()

Returns null. Required in 1.5 and kills 1.4 compilation since this is new. Simplest workaround for 1.4 is probably to create TypeVariable.java with package com.sun.javadoc and an empty class declaration in this local directory.

Specified by:

asTypeVariable in interface com.sun.javadoc.Type

asParameterizedType

public com.sun.javadoc.ParameterizedType asParameterizedType()

Returns null. Required in 1.5 and kills 1.4 compilation. Simplest workaround for 1.4 is probably to create ParameterizedType.java with package com.sun.javadoc and an empty class declaration in this local directory.

Specified by:

asParameterizedType in interface com.sun.javadoc.Type

isPrimitive

public boolean isPrimitive()

Returns false. Required in 1.5

Specified by:

isPrimitive in interface com.sun.javadoc.Type

simpleTypeName

public java.lang.String simpleTypeName()

Returns typeName. Required in 1.5

Specified by:

simpleTypeName in interface com.sun.javadoc.Type