oracle.ide.config

Class DocumentExtensions.DocRecord

java.lang.Object

oracle.ide.config.DocumentExtensions.DocRecord

All Implemented Interfaces:

Copyable

Enclosing class:

DocumentExtensions

public static class DocumentExtensions.DocRecord
extends java.lang.Object
implements Copyable

DocRecord class. Stores information about a given document type. Such information includes: the file extensions associated with the document type, the icon representing the document type, and the document type display label.

Constructor Summary

Constructors

Constructor and Description
DocRecord() Constructors.
DocRecord(java.lang.Class docClass, DocumentInfo info)

Method Summary

Modifier and Type	Method and Description
DocumentExtensions.ExtInfo	addIdeExtension(java.lang.String extension) Associate the specified extension with the document type encapsulated in this DocRecord.
DocumentExtensions.ExtInfo	addUserExtension(java.lang.String extension) Associate the specified extension with the document type encapsulated in this DocRecord.
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(DocumentExtensions.DocRecord copy)
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(DocumentExtensions.DocRecord other)
java.lang.Class	getDocClass() Returns the document type.
java.lang.String	getDocClassName() Returns the document type name.
java.util.List	getExtensions() Returns a List of ide and user extensions.
javax.swing.Icon	getIcon() Returns the Icon representing this document type.
java.lang.String	getLabel() Returns the display label describing this document type.
java.util.List	getUserExtensions() Returns a List of user extensions.
int	hashCode()
boolean	isExtensionInUse(java.lang.String ext)
DocumentExtensions.ExtInfo	removeUserExtension(java.lang.String extension) Disassociate the specified extension from the document type encapsulated in this DocRecord.
static java.lang.String	sanitizeExtensionAsString(java.lang.String extension)
void	setDocClassName(java.lang.String docClassName) Sets the document type name.
void	setUserExtensions(java.util.List extensions) Sets the list of user extensions.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocRecord

public DocRecord()

Constructors.

DocRecord

public DocRecord(java.lang.Class docClass,
                 DocumentInfo info)

Method Detail

sanitizeExtensionAsString

public static java.lang.String sanitizeExtensionAsString(java.lang.String extension)

addIdeExtension

public DocumentExtensions.ExtInfo addIdeExtension(java.lang.String extension)

Associate the specified extension with the document type encapsulated in this DocRecord. Use this method to add extensions that cannot be disassociated from the document type.

addUserExtension

public DocumentExtensions.ExtInfo addUserExtension(java.lang.String extension)

Associate the specified extension with the document type encapsulated in this DocRecord. Use this method to add extensions that can be disassociated from the document type.

removeUserExtension

public DocumentExtensions.ExtInfo removeUserExtension(java.lang.String extension)

Disassociate the specified extension from the document type encapsulated in this DocRecord.

getIcon

public javax.swing.Icon getIcon()

Returns the Icon representing this document type.

getLabel

public java.lang.String getLabel()

Returns the display label describing this document type.

getDocClass

public java.lang.Class getDocClass()

Returns the document type.

getExtensions

public java.util.List getExtensions()

Returns a List of ide and user extensions.

isExtensionInUse

public boolean isExtensionInUse(java.lang.String ext)

getUserExtensions

public java.util.List getUserExtensions()

Returns a List of user extensions. The list items are of type DocumentExtensions.ExtInfo.

setUserExtensions

public void setUserExtensions(java.util.List extensions)

Sets the list of user extensions. The list items must be of type DocumentExtensions.ExtInfo.

getDocClassName

public java.lang.String getDocClassName()

Returns the document type name.

setDocClassName

public void setDocClassName(java.lang.String docClassName)

Sets the document type name.

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected final void copyToImpl(DocumentExtensions.DocRecord copy)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(DocumentExtensions.DocRecord other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object