org.jopendocument.dom
Class Library.LinkedLibrary

java.lang.Object
  extended by org.jopendocument.dom.Library
      extended by org.jopendocument.dom.Library.LinkedLibrary
Enclosing class:
Library

@Immutable
public static final class Library.LinkedLibrary
extends Library


Nested Class Summary
 
Nested classes/interfaces inherited from class org.jopendocument.dom.Library
Library.EmbeddedLibrary, Library.LinkedLibrary
 
Field Summary
 
Fields inherited from class org.jopendocument.dom.Library
DIALOG_DIR_NAME, DIALOG_LIBRARY_LIST_FILENAME, DIALOG_LIST_FILENAME, DIR_NAME, LIBRARY_LIST_FILENAME, MODULE_LIST_FILENAME
 
Method Summary
 boolean canBeMerged(Library other)
          Whether this library can be merged with the passed one.
 boolean equals(Object obj)
           
 String getHref()
           
 String getType()
           
 int hashCode()
           
 org.jdom.Element toFlatXML(XMLFormatVersion vers)
          The element to define this in a flat XML.
 Map<String,org.jdom.Document> toPackageDialogDocuments(XMLFormatVersion vers)
           
 Map<String,org.jdom.Document> toPackageDocuments(XMLFormatVersion vers)
          The documents to include in a package.
 org.jdom.Element toPackageLibrariesElement(XMLFormatVersion vers)
          The element to include in the "script-lc.xml" entry in a package.
 
Methods inherited from class org.jopendocument.dom.Library
getName, isReadonly, removeFromPackage
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getHref

public final String getHref()

getType

public final String getType()

toFlatXML

public org.jdom.Element toFlatXML(XMLFormatVersion vers)
Description copied from class: Library
The element to define this in a flat XML.

Specified by:
toFlatXML in class Library
Parameters:
vers - the version of the format.
Returns:
an element totally defining this.

toPackageLibrariesElement

public org.jdom.Element toPackageLibrariesElement(XMLFormatVersion vers)
Description copied from class: Library
The element to include in the "script-lc.xml" entry in a package.

Specified by:
toPackageLibrariesElement in class Library
Parameters:
vers - the version of the format.
Returns:
an element defining the properties of this.
See Also:
Library.toPackageDocuments(XMLFormatVersion)

toPackageDocuments

public Map<String,org.jdom.Document> toPackageDocuments(XMLFormatVersion vers)
Description copied from class: Library
The documents to include in a package.

Specified by:
toPackageDocuments in class Library
Parameters:
vers - the version of the format.
Returns:
documents totally defining this, by file name.

toPackageDialogDocuments

public Map<String,org.jdom.Document> toPackageDialogDocuments(XMLFormatVersion vers)
Specified by:
toPackageDialogDocuments in class Library

canBeMerged

public boolean canBeMerged(Library other)
Description copied from class: Library
Whether this library can be merged with the passed one. The merge can happen if there's no overlap between the two, or if the content of the overlap is equal (e.g. both define the module 'foo' with the same content).

Specified by:
canBeMerged in class Library
Parameters:
other - another library.
Returns:
true if this library and the other can be merged.

hashCode

public int hashCode()
Overrides:
hashCode in class Library

equals

public boolean equals(Object obj)
Overrides:
equals in class Library


Copyright © 2010 jOpenDocument All Rights Reserved.