You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2013/06/26 01:34:23 UTC
svn commit: r1496673 - /poi/trunk/src/java/org/apache/poi/POIDocument.java
Author: nick
Date: Tue Jun 25 23:34:22 2013
New Revision: 1496673
URL: http://svn.apache.org/r1496673
Log:
Fix to have consistent whitespace, and add javadoc deprecated entries
Modified:
poi/trunk/src/java/org/apache/poi/POIDocument.java
Modified: poi/trunk/src/java/org/apache/poi/POIDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/POIDocument.java?rev=1496673&r1=1496672&r2=1496673&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/POIDocument.java (original)
+++ poi/trunk/src/java/org/apache/poi/POIDocument.java Tue Jun 25 23:34:22 2013
@@ -47,15 +47,15 @@ import org.apache.poi.util.POILogger;
* @author Nick Burch
*/
public abstract class POIDocument {
- /** Holds metadata on our document */
- private SummaryInformation sInf;
- /** Holds further metadata on our document */
- private DocumentSummaryInformation dsInf;
- /** The directory that our document lives in */
- protected DirectoryNode directory;
-
- /** For our own logging use */
- private final static POILogger logger = POILogFactory.getLogger(POIDocument.class);
+ /** Holds metadata on our document */
+ private SummaryInformation sInf;
+ /** Holds further metadata on our document */
+ private DocumentSummaryInformation dsInf;
+ /** The directory that our document lives in */
+ protected DirectoryNode directory;
+
+ /** For our own logging use */
+ private final static POILogger logger = POILogFactory.getLogger(POIDocument.class);
/* Have the property streams been read yet? (Only done on-demand) */
private boolean initialized = false;
@@ -78,168 +78,169 @@ public abstract class POIDocument {
this(fs.getRoot());
}
- /**
- * Fetch the Document Summary Information of the document
- */
- public DocumentSummaryInformation getDocumentSummaryInformation() {
+ /**
+ * Fetch the Document Summary Information of the document
+ */
+ public DocumentSummaryInformation getDocumentSummaryInformation() {
if(!initialized) readProperties();
return dsInf;
}
- /**
- * Fetch the Summary Information of the document
- */
- public SummaryInformation getSummaryInformation() {
+ /**
+ * Fetch the Summary Information of the document
+ */
+ public SummaryInformation getSummaryInformation() {
if(!initialized) readProperties();
return sInf;
}
- /**
- * Will create whichever of SummaryInformation
- * and DocumentSummaryInformation (HPSF) properties
- * are not already part of your document.
- * This is normally useful when creating a new
- * document from scratch.
- * If the information properties are already there,
- * then nothing will happen.
- */
- public void createInformationProperties() {
- if(!initialized) readProperties();
- if(sInf == null) {
- sInf = PropertySetFactory.newSummaryInformation();
- }
- if(dsInf == null) {
- dsInf = PropertySetFactory.newDocumentSummaryInformation();
- }
- }
-
- /**
- * Find, and create objects for, the standard
- * Documment Information Properties (HPSF).
- * If a given property set is missing or corrupt,
- * it will remain null;
- */
- protected void readProperties() {
- PropertySet ps;
-
- // DocumentSummaryInformation
- ps = getPropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
- if(ps != null && ps instanceof DocumentSummaryInformation) {
- dsInf = (DocumentSummaryInformation)ps;
- } else if(ps != null) {
- logger.log(POILogger.WARN, "DocumentSummaryInformation property set came back with wrong class - ", ps.getClass());
- }
-
- // SummaryInformation
- ps = getPropertySet(SummaryInformation.DEFAULT_STREAM_NAME);
- if(ps instanceof SummaryInformation) {
- sInf = (SummaryInformation)ps;
- } else if(ps != null) {
- logger.log(POILogger.WARN, "SummaryInformation property set came back with wrong class - ", ps.getClass());
- }
+ /**
+ * Will create whichever of SummaryInformation
+ * and DocumentSummaryInformation (HPSF) properties
+ * are not already part of your document.
+ * This is normally useful when creating a new
+ * document from scratch.
+ * If the information properties are already there,
+ * then nothing will happen.
+ */
+ public void createInformationProperties() {
+ if (!initialized) readProperties();
+ if (sInf == null) {
+ sInf = PropertySetFactory.newSummaryInformation();
+ }
+ if (dsInf == null) {
+ dsInf = PropertySetFactory.newDocumentSummaryInformation();
+ }
+ }
- // Mark the fact that we've now loaded up the properties
+ /**
+ * Find, and create objects for, the standard
+ * Documment Information Properties (HPSF).
+ * If a given property set is missing or corrupt,
+ * it will remain null;
+ */
+ protected void readProperties() {
+ PropertySet ps;
+
+ // DocumentSummaryInformation
+ ps = getPropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
+ if (ps != null && ps instanceof DocumentSummaryInformation) {
+ dsInf = (DocumentSummaryInformation)ps;
+ } else if(ps != null) {
+ logger.log(POILogger.WARN, "DocumentSummaryInformation property set came back with wrong class - ", ps.getClass());
+ }
+
+ // SummaryInformation
+ ps = getPropertySet(SummaryInformation.DEFAULT_STREAM_NAME);
+ if (ps instanceof SummaryInformation) {
+ sInf = (SummaryInformation)ps;
+ } else if(ps != null) {
+ logger.log(POILogger.WARN, "SummaryInformation property set came back with wrong class - ", ps.getClass());
+ }
+
+ // Mark the fact that we've now loaded up the properties
initialized = true;
- }
+ }
- /**
- * For a given named property entry, either return it or null if
- * if it wasn't found
- */
- protected PropertySet getPropertySet(String setName) {
- //directory can be null when creating new documents
- if(directory == null || !directory.hasEntry(setName)) return null;
-
- DocumentInputStream dis;
- try {
- // Find the entry, and get an input stream for it
- dis = directory.createDocumentInputStream( directory.getEntry(setName) );
- } catch(IOException ie) {
- // Oh well, doesn't exist
- logger.log(POILogger.WARN, "Error getting property set with name " + setName + "\n" + ie);
- return null;
- }
-
- try {
- // Create the Property Set
- PropertySet set = PropertySetFactory.create(dis);
- return set;
- } catch(IOException ie) {
- // Must be corrupt or something like that
- logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + ie);
- } catch(org.apache.poi.hpsf.HPSFException he) {
- // Oh well, doesn't exist
- logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + he);
- }
- return null;
- }
-
- /**
- * Writes out the standard Documment Information Properties (HPSF)
- * @param outFS the POIFSFileSystem to write the properties into
- */
- protected void writeProperties(POIFSFileSystem outFS) throws IOException {
- writeProperties(outFS, null);
- }
- /**
- * Writes out the standard Documment Information Properties (HPSF)
- * @param outFS the POIFSFileSystem to write the properties into
- * @param writtenEntries a list of POIFS entries to add the property names too
- */
- protected void writeProperties(POIFSFileSystem outFS, List<String> writtenEntries) throws IOException {
+ /**
+ * For a given named property entry, either return it or null if
+ * if it wasn't found
+ */
+ protected PropertySet getPropertySet(String setName) {
+ //directory can be null when creating new documents
+ if (directory == null || !directory.hasEntry(setName))
+ return null;
+
+ DocumentInputStream dis;
+ try {
+ // Find the entry, and get an input stream for it
+ dis = directory.createDocumentInputStream( directory.getEntry(setName) );
+ } catch(IOException ie) {
+ // Oh well, doesn't exist
+ logger.log(POILogger.WARN, "Error getting property set with name " + setName + "\n" + ie);
+ return null;
+ }
+
+ try {
+ // Create the Property Set
+ PropertySet set = PropertySetFactory.create(dis);
+ return set;
+ } catch(IOException ie) {
+ // Must be corrupt or something like that
+ logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + ie);
+ } catch(org.apache.poi.hpsf.HPSFException he) {
+ // Oh well, doesn't exist
+ logger.log(POILogger.WARN, "Error creating property set with name " + setName + "\n" + he);
+ }
+ return null;
+ }
+
+ /**
+ * Writes out the standard Documment Information Properties (HPSF)
+ * @param outFS the POIFSFileSystem to write the properties into
+ */
+ protected void writeProperties(POIFSFileSystem outFS) throws IOException {
+ writeProperties(outFS, null);
+ }
+ /**
+ * Writes out the standard Documment Information Properties (HPSF)
+ * @param outFS the POIFSFileSystem to write the properties into
+ * @param writtenEntries a list of POIFS entries to add the property names too
+ */
+ protected void writeProperties(POIFSFileSystem outFS, List<String> writtenEntries) throws IOException {
SummaryInformation si = getSummaryInformation();
- if(si != null) {
- writePropertySet(SummaryInformation.DEFAULT_STREAM_NAME, si, outFS);
- if(writtenEntries != null) {
- writtenEntries.add(SummaryInformation.DEFAULT_STREAM_NAME);
- }
- }
+ if (si != null) {
+ writePropertySet(SummaryInformation.DEFAULT_STREAM_NAME, si, outFS);
+ if(writtenEntries != null) {
+ writtenEntries.add(SummaryInformation.DEFAULT_STREAM_NAME);
+ }
+ }
DocumentSummaryInformation dsi = getDocumentSummaryInformation();
- if(dsi != null) {
- writePropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME, dsi, outFS);
- if(writtenEntries != null) {
- writtenEntries.add(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
- }
- }
- }
-
- /**
- * Writes out a given ProperySet
- * @param name the (POIFS Level) name of the property to write
- * @param set the PropertySet to write out
- * @param outFS the POIFSFileSystem to write the property into
- */
- protected void writePropertySet(String name, PropertySet set, POIFSFileSystem outFS) throws IOException {
- try {
- MutablePropertySet mSet = new MutablePropertySet(set);
- ByteArrayOutputStream bOut = new ByteArrayOutputStream();
-
- mSet.write(bOut);
- byte[] data = bOut.toByteArray();
- ByteArrayInputStream bIn = new ByteArrayInputStream(data);
- outFS.createDocument(bIn,name);
-
- logger.log(POILogger.INFO, "Wrote property set " + name + " of size " + data.length);
- } catch(org.apache.poi.hpsf.WritingNotSupportedException wnse) {
- logger.log( POILogger.ERROR, "Couldn't write property set with name " + name + " as not supported by HPSF yet");
- }
- }
+ if (dsi != null) {
+ writePropertySet(DocumentSummaryInformation.DEFAULT_STREAM_NAME, dsi, outFS);
+ if(writtenEntries != null) {
+ writtenEntries.add(DocumentSummaryInformation.DEFAULT_STREAM_NAME);
+ }
+ }
+ }
- /**
- * Writes the document out to the specified output stream
- */
- public abstract void write(OutputStream out) throws IOException;
-
- /**
- * Copies nodes from one POIFS to the other minus the excepts
- * @param source is the source POIFS to copy from
- * @param target is the target POIFS to copy to
- * @param excepts is a list of Strings specifying what nodes NOT to copy
- */
- @Deprecated
+ /**
+ * Writes out a given ProperySet
+ * @param name the (POIFS Level) name of the property to write
+ * @param set the PropertySet to write out
+ * @param outFS the POIFSFileSystem to write the property into
+ */
+ protected void writePropertySet(String name, PropertySet set, POIFSFileSystem outFS) throws IOException {
+ try {
+ MutablePropertySet mSet = new MutablePropertySet(set);
+ ByteArrayOutputStream bOut = new ByteArrayOutputStream();
+
+ mSet.write(bOut);
+ byte[] data = bOut.toByteArray();
+ ByteArrayInputStream bIn = new ByteArrayInputStream(data);
+ outFS.createDocument(bIn,name);
+
+ logger.log(POILogger.INFO, "Wrote property set " + name + " of size " + data.length);
+ } catch(org.apache.poi.hpsf.WritingNotSupportedException wnse) {
+ logger.log( POILogger.ERROR, "Couldn't write property set with name " + name + " as not supported by HPSF yet");
+ }
+ }
+
+ /**
+ * Writes the document out to the specified output stream
+ */
+ public abstract void write(OutputStream out) throws IOException;
+
+ /**
+ * Copies nodes from one POIFS to the other minus the excepts
+ * @param source is the source POIFS to copy from
+ * @param target is the target POIFS to copy to
+ * @param excepts is a list of Strings specifying what nodes NOT to copy
+ * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List<String)} instead
+ */
+ @Deprecated
protected void copyNodes( POIFSFileSystem source, POIFSFileSystem target,
- List<String> excepts ) throws IOException
- {
+ List<String> excepts ) throws IOException {
EntryUtils.copyNodes( source, target, excepts );
}
@@ -248,6 +249,7 @@ public abstract class POIDocument {
* @param sourceRoot is the source POIFS to copy from
* @param targetRoot is the target POIFS to copy to
* @param excepts is a list of Strings specifying what nodes NOT to copy
+ * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List<String)} instead
*/
@Deprecated
protected void copyNodes( DirectoryNode sourceRoot,
@@ -256,9 +258,10 @@ public abstract class POIDocument {
EntryUtils.copyNodes( sourceRoot, targetRoot, excepts );
}
- /**
- * Copies an Entry into a target POIFS directory, recursively
- */
+ /**
+ * Copies an Entry into a target POIFS directory, recursively
+ * @deprecated Use {@link EntryUtils#copyNodeRecursively(Entry, DirectoryEntry)} instead
+ */
@Internal
@Deprecated
protected void copyNodeRecursively( Entry entry, DirectoryEntry target )
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org