diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/HyperlinkRelationship.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/HyperlinkRelationship.java index 5332c8c120..d34756f245 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/HyperlinkRelationship.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/HyperlinkRelationship.java @@ -23,7 +23,7 @@ import java.net.URI; /** * Represents a hyperlink relationship. * - * @since POI 5.3.0 + * @since 5.3.0 */ public class HyperlinkRelationship extends ReferenceRelationship { /** diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java index 24479bad22..e47b04c43b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java @@ -155,7 +155,7 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close * @return the document's embedded files * * @throws OpenXML4JException if the embedded parts can't be determined - * @since POI 4.0.0 + * @since 4.0.0 */ public abstract List getAllEmbeddedParts() throws OpenXML4JException; diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java index 200b035091..64ed50b4bd 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java @@ -167,7 +167,7 @@ public class POIXMLDocumentPart { * * @param part - The package part that holds xml data representing this sheet. * @see #read(POIXMLFactory, Map) - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public POIXMLDocumentPart(PackagePart part) { this(null, part); @@ -180,7 +180,7 @@ public class POIXMLDocumentPart { * @param parent - Parent part * @param part - The package part that holds xml data representing this sheet. * @see #read(POIXMLFactory, Map) - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part) { this.packagePart = part; @@ -749,7 +749,7 @@ public class POIXMLDocumentPart { * * @param relId the part which is to be removed * @return true, if the relation was removed - * @since POI 5.3.0 + * @since 5.3.0 */ public final boolean removeReferenceRelationship(String relId) { ReferenceRelationship existing = referenceRelationships.remove(relId); @@ -766,7 +766,7 @@ public class POIXMLDocumentPart { * * @param relId the relation id * @return the reference relationship or {@code null} if not found - * @since POI 5.3.0 + * @since 5.3.0 */ public final ReferenceRelationship getReferenceRelationship(String relId) { return referenceRelationships.get(relId); @@ -779,7 +779,7 @@ public class POIXMLDocumentPart { * @param isExternal true, if the target is an external resource * @param relId the relation id * @return the created reference relationship - * @since POI 5.3.0 + * @since 5.3.0 */ public final HyperlinkRelationship createHyperlink(URI uri, boolean isExternal, String relId) { PackageRelationship pr = packagePart.addRelationship(uri, isExternal ? TargetMode.EXTERNAL : TargetMode.INTERNAL, @@ -793,7 +793,7 @@ public class POIXMLDocumentPart { * Returns an unmodifiable list of reference relationships for this POIXMLDocumentPart. * * @return reference relationships - * @since POI 5.3.0 + * @since 5.3.0 * @see #getRelationParts() for child relations */ public final List getReferenceRelationships() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLFactory.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLFactory.java index bc4ed76961..1c0d37888f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLFactory.java @@ -75,7 +75,7 @@ public abstract class POIXMLFactory { * @param relationshipType the relationship type of the descriptor * @return the descriptor or null if type is unknown * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected abstract POIXMLRelation getDescriptor(String relationshipType); @@ -104,7 +104,7 @@ public abstract class POIXMLFactory { * * @throws POIXMLException if the relations are erroneous or the part is not related * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected PackageRelationship getPackageRelationship(POIXMLDocumentPart parent, PackagePart part) { try { diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLProperties.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLProperties.java index af423bf157..256442e8ba 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLProperties.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLProperties.java @@ -316,11 +316,11 @@ public class POIXMLProperties { public void setLastPrinted(String date) throws InvalidFormatException { part.setLastPrintedProperty(date); } - /** @since POI 3.15 beta 3 */ + /** @since 3.15 beta 3 */ public String getLastModifiedByUser() { return part.getLastModifiedByProperty().orElse(null); } - /** @since POI 3.15 beta 3 */ + /** @since 3.15 beta 3 */ public void setLastModifiedByUser(String user) { part.setLastModifiedByProperty(user); } @@ -349,7 +349,7 @@ public class POIXMLProperties { /** * Sets the version property. * @param version property value - * @since POI 5.2.3 + * @since 5.2.3 */ public void setVersion(String version) { part.setVersionProperty(version); @@ -358,7 +358,7 @@ public class POIXMLProperties { /** * Returns the version property value. * @return version property (can be null) - * @since POI 5.2.3 + * @since 5.2.3 */ public String getVersion() { return part.getVersionProperty().orElse(null); @@ -399,7 +399,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setTemplate(String template) { props.getProperties().setTemplate(template); } @@ -409,7 +409,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setManager(String manager) { props.getProperties().setManager(manager); } @@ -419,7 +419,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setCompany(String company) { props.getProperties().setCompany(company); } @@ -429,7 +429,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setPresentationFormat(String presentationFormat) { props.getProperties().setPresentationFormat(presentationFormat); } @@ -439,7 +439,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setApplication(String application) { props.getProperties().setApplication(application); } @@ -449,7 +449,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setAppVersion(String appVersion) { props.getProperties().setAppVersion(appVersion); } @@ -460,7 +460,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setPages(int pages) { props.getProperties().setPages(pages); } @@ -470,7 +470,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setWords(int words) { props.getProperties().setWords(words); } @@ -480,7 +480,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setCharacters(int characters) { props.getProperties().setCharacters(characters); } @@ -490,7 +490,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setCharactersWithSpaces(int charactersWithSpaces) { props.getProperties().setCharactersWithSpaces(charactersWithSpaces); } @@ -500,7 +500,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setLines(int lines) { props.getProperties().setLines(lines); } @@ -510,7 +510,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setParagraphs(int paragraphs) { props.getProperties().setParagraphs(paragraphs); } @@ -520,7 +520,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setSlides(int slides) { props.getProperties().setSlides(slides); } @@ -530,7 +530,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setNotes(int notes) { props.getProperties().setNotes(notes); } @@ -540,7 +540,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setTotalTime(int totalTime) { props.getProperties().setTotalTime(totalTime); } @@ -550,7 +550,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setHiddenSlides(int hiddenSlides) { props.getProperties().setHiddenSlides(hiddenSlides); } @@ -560,7 +560,7 @@ public class POIXMLProperties { } return -1; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setMMClips(int mmClips) { props.getProperties().setMMClips(mmClips); } @@ -571,7 +571,7 @@ public class POIXMLProperties { } return null; } - /** @since POI 4.1.1 */ + /** @since 4.1.1 */ public void setHyperlinkBase(String hyperlinkBase) { props.getProperties().setHyperlinkBase(hyperlinkBase); } diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/ReferenceRelationship.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/ReferenceRelationship.java index 9a20887f45..c802157f44 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/ReferenceRelationship.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/ReferenceRelationship.java @@ -24,7 +24,7 @@ import java.net.URI; /** * Defines a reference relationship. A reference relationship can be internal or external. * - * @since POI 5.3.0 + * @since 5.3.0 */ public abstract class ReferenceRelationship { private POIXMLDocumentPart container; diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/extractor/POIXMLExtractorFactory.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/extractor/POIXMLExtractorFactory.java index e1981e9f60..7aef57bf55 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/extractor/POIXMLExtractorFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/extractor/POIXMLExtractorFactory.java @@ -119,7 +119,7 @@ public final class POIXMLExtractorFactory implements ExtractorProvider { * Clears the setting for this thread made by {@link #setThreadPrefersEventExtractors(boolean) } * * @see #setThreadPrefersEventExtractors(boolean) - * @since POI 5.2.4 + * @since 5.2.4 */ public static void removeThreadPrefersEventExtractorsSetting() { ExtractorFactory.removeThreadPrefersEventExtractorsSetting(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/NumberHelper.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/NumberHelper.java index dbb397c448..0753c8e3bb 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/NumberHelper.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/NumberHelper.java @@ -23,7 +23,7 @@ import org.apache.poi.util.Internal; * Helper class for number related operations. *

Note: This class is for internal POI usage only.

* - * @since POI 5.5.0 + * @since 5.5.0 */ @Internal public class NumberHelper { diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java index e52169e224..b519aeabb1 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java @@ -58,7 +58,7 @@ public final class PackageHelper { * @return OPCPackage * @throws IOException If reading data from the stream fails * @throws POIXMLException If the stream is not a valid OPC package - * @since POI 5.2.0 + * @since 5.2.0 */ public static OPCPackage open(InputStream stream, boolean closeStream) throws IOException { try { diff --git a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/XPathHelper.java b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/XPathHelper.java index f4fcf57fe7..a0ba2d67f5 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/XPathHelper.java +++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/util/XPathHelper.java @@ -102,7 +102,7 @@ public final class XPathHelper { * thrown if the AlternateContent is not allowed by the surrounding element or if the * extracted object is of the generic type XmlAnyTypeImpl. * - * @since POI 4.1.2 + * @since 4.1.2 */ @SuppressWarnings("unchecked") @Internal diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCComplianceFlags.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCComplianceFlags.java index e288c8c022..37e83cedf0 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCComplianceFlags.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCComplianceFlags.java @@ -24,7 +24,7 @@ package org.apache.poi.openxml4j.opc; * * Consumers may disable these compliance checks individually or as a whole at their * own discretion to allow certain non-compliant documents to be parsed. - * @since POI 5.4.1 + * @since 5.4.1 */ public class OPCComplianceFlags { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCPackage.java index 7b5e88647f..afdb5a5800 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCPackage.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCPackage.java @@ -151,7 +151,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @param opcComplianceFlags Enable or disable specific OPC compliance flags. * This is useful to allow parsing of certain non-compliant documents. * @throws OpenXML4JRuntimeException if there are issues creating properties part - * @since POI 5.4.1 + * @since 5.4.1 */ OPCPackage(PackageAccess access, OPCComplianceFlags opcComplianceFlags) { if (getClass() != ZipPackage.class) { @@ -203,7 +203,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @throws InvalidFormatException * If the specified file doesn't exist, and a parsing error * occur. - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(String path, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { return open(path, defaultPackageAccess, opcComplianceFlags); @@ -234,7 +234,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @throws InvalidFormatException * If the specified file doesn't exist, and a parsing error * occur. - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(File file, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { return open(file, defaultPackageAccess, opcComplianceFlags); @@ -265,7 +265,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * The level of OPC compliance to enforce when reading the package * @return A Package object * @throws InvalidFormatException if a parsing error occur. - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(ZipEntrySource zipEntry, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { OPCPackage pack = new ZipPackage(zipEntry, PackageAccess.READ, opcComplianceFlags); @@ -317,7 +317,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * occur. * @throws InvalidOperationException If the zip file cannot be opened. * @throws InvalidFormatException if the package is not valid. - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(String path, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException, InvalidOperationException { @@ -378,7 +378,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * If the specified file doesn't exist or is a directory. * @throws InvalidFormatException * If a parsing error occurs. - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(File file, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { @@ -447,7 +447,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @throws InvalidFormatException * Throws if the specified file exist and is not valid. * @throws IOException If reading the stream fails - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(InputStream in, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException, IOException { @@ -484,7 +484,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @throws InvalidFormatException * Throws if the specified file exist and is not valid. * @throws IOException If reading the stream fails - * @since POI 5.2.5 + * @since 5.2.5 */ public static OPCPackage open(InputStream in, boolean closeStream) throws InvalidFormatException, IOException { @@ -509,7 +509,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @throws InvalidFormatException * Throws if the specified file exist and is not valid. * @throws IOException If reading the stream fails - * @since POI 5.4.1 + * @since 5.4.1 */ public static OPCPackage open(InputStream in, boolean closeStream, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException, IOException { @@ -1796,7 +1796,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { * @param oldContentType the content type to be replaced * @param newContentType the replacement * @return whether replacement was successful - * @since POI-3.8 + * @since -3.8 */ public boolean replaceContentType(String oldContentType, String newContentType){ boolean success = false; @@ -1861,7 +1861,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { /** * @return true if the package is in Strict OOXML format - * @since POI 5.1.0 + * @since 5.1.0 */ public boolean isStrictOoxmlFormat() { PackageRelationshipCollection coreDocRelationships = getRelationshipsByType( diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackageRelationshipCollection.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackageRelationshipCollection.java index e2d3943266..2b1d012ca7 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackageRelationshipCollection.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackageRelationshipCollection.java @@ -287,7 +287,7 @@ public final class PackageRelationshipCollection implements Iterable spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ZipPackage.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ZipPackage.java index 0ae478a6cd..1fe78faca8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ZipPackage.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ZipPackage.java @@ -110,7 +110,7 @@ public final class ZipPackage extends OPCPackage { * Constructor. Creates a new, empty ZipPackage. * @param opcComplianceFlags * The level of OPC compliance to enforce when reading the package - * @since POI 5.4.1 + * @since 5.4.1 */ public ZipPackage(OPCComplianceFlags opcComplianceFlags) { super(defaultPackageAccess, opcComplianceFlags); @@ -156,7 +156,7 @@ public final class ZipPackage extends OPCPackage { * ZipInputStream. * @throws IOException * if input stream cannot be opened, read, or closed - * @since POI 5.4.1 + * @since 5.4.1 */ ZipPackage(InputStream in, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws IOException { super(access, opcComplianceFlags); @@ -180,7 +180,7 @@ public final class ZipPackage extends OPCPackage { * ZipInputStream. * @throws IOException * if input stream cannot be opened, read, or closed - * @since POI 5.2.5 + * @since 5.2.5 */ ZipPackage(InputStream in, PackageAccess access, boolean closeStream) throws IOException { this(in, access, closeStream, OPCComplianceFlags.enforceAll()); @@ -203,7 +203,7 @@ public final class ZipPackage extends OPCPackage { * ZipInputStream. * @throws IOException * if input stream cannot be opened, read, or closed - * @since POI 5.4.1 + * @since 5.4.1 */ ZipPackage(InputStream in, PackageAccess access, boolean closeStream, OPCComplianceFlags opcComplianceFlags) throws IOException { super(access, opcComplianceFlags); @@ -235,7 +235,7 @@ public final class ZipPackage extends OPCPackage { * @param opcComplianceFlags * The level of OPC compliance to enforce when reading the package * @throws InvalidOperationException If the zip file cannot be opened. - * @since POI 5.4.1 + * @since 5.4.1 */ ZipPackage(String path, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidOperationException { this(new File(path), access, opcComplianceFlags); @@ -264,7 +264,7 @@ public final class ZipPackage extends OPCPackage { * @param opcComplianceFlags * The level of OPC compliance to enforce when reading the package * @throws InvalidOperationException If the zip file cannot be opened. - * @since POI 5.4.1 + * @since 5.4.1 */ ZipPackage(File file, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidOperationException { super(access, opcComplianceFlags); @@ -348,7 +348,7 @@ public final class ZipPackage extends OPCPackage { * The package access mode. * @param access * The package access mode. - * @since POI 5.4.1 + * @since 5.4.1 */ ZipPackage(ZipEntrySource zipEntry, PackageAccess access, OPCComplianceFlags opcComplianceFlags) { super(access, opcComplianceFlags); diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/EncryptedTempFilePackagePart.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/EncryptedTempFilePackagePart.java index ee28a3937d..21e20090ca 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/EncryptedTempFilePackagePart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/EncryptedTempFilePackagePart.java @@ -34,7 +34,7 @@ import java.io.*; /** * (Experimental) Encrypted Temp File version of a package part. * - * @since POI 5.1.0 + * @since 5.1.0 */ @Beta public final class EncryptedTempFilePackagePart extends PackagePart { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/InvalidZipException.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/InvalidZipException.java index ae57393b12..63c3c84834 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/InvalidZipException.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/InvalidZipException.java @@ -22,7 +22,7 @@ import java.io.IOException; /** * Thrown if the zip file is invalid. * - * @since POI 5.4.0 + * @since 5.4.0 */ public class InvalidZipException extends IOException { public InvalidZipException(String message) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/TempFilePackagePart.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/TempFilePackagePart.java index 4872599dc1..576d37afeb 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/TempFilePackagePart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/TempFilePackagePart.java @@ -35,7 +35,7 @@ import java.nio.file.Files; /** * (Experimental) Temp File version of a package part. * - * @since POI 5.1.0 + * @since 5.1.0 */ @Beta public final class TempFilePackagePart extends PackagePart { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/unmarshallers/PackagePropertiesUnmarshaller.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/unmarshallers/PackagePropertiesUnmarshaller.java index 9ac8083a32..7a85cb15fd 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/unmarshallers/PackagePropertiesUnmarshaller.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/unmarshallers/PackagePropertiesUnmarshaller.java @@ -56,7 +56,7 @@ public final class PackagePropertiesUnmarshaller implements PartUnmarshaller { /** * @param opcComplianceFlags Overrides the default OPC compliance settings - * @since POI 5.4.1 + * @since 5.4.1 */ public PackagePropertiesUnmarshaller(OPCComplianceFlags opcComplianceFlags) { this.opcComplianceFlags = opcComplianceFlags; diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipArchiveFakeEntry.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipArchiveFakeEntry.java index 9648476001..fc33f072fa 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipArchiveFakeEntry.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipArchiveFakeEntry.java @@ -124,7 +124,7 @@ public final class ZipArchiveFakeEntry extends ZipArchiveEntry implements Closea /** * Deletes any temp files and releases any byte arrays. * @throws IOException If closing the entry fails. - * @since POI 5.1.0 + * @since 5.1.0 */ @Override public void close() throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipEntrySource.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipEntrySource.java index 8f4737038a..c1a5269f0c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipEntrySource.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipEntrySource.java @@ -41,7 +41,7 @@ public interface ZipEntrySource extends Closeable { * @param path the path in unix-notation * @return the entry or {@code null} if not found * - * @since POI 4.0.0 + * @since 4.0.0 */ ZipArchiveEntry getEntry(String path); diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipInputStreamZipEntrySource.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipInputStreamZipEntrySource.java index 5bc09a73e3..ecdbb95ecf 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipInputStreamZipEntrySource.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipInputStreamZipEntrySource.java @@ -51,7 +51,7 @@ public class ZipInputStreamZipEntrySource implements ZipEntrySource { * and the data is put in a temp file instead - defaults to -1 meaning temp files are not used * and that zip entries with more than 2GB of data after decompressing will fail, 0 means all * zip entries are stored in temp files. A threshold like 50000000 (approx 50Mb is recommended) - * @since POI 5.1.0 + * @since 5.1.0 * @see #setEncryptTempFiles(boolean) */ public static void setThresholdBytesForTempFiles(int thresholdBytes) { @@ -62,7 +62,7 @@ public class ZipInputStreamZipEntrySource implements ZipEntrySource { * Get the threshold at which a zip entry is regarded as too large for holding in memory * and the data is put in a temp file instead (defaults to -1 meaning temp files are not used) * @return threshold in bytes - * @since POI 5.1.0 + * @since 5.1.0 */ public static int getThresholdBytesForTempFiles() { return thresholdForTempFiles; @@ -71,7 +71,7 @@ public class ZipInputStreamZipEntrySource implements ZipEntrySource { /** * Encrypt temp files when they are used. Only affects temp files related to zip entries. * @param encrypt whether temp files should be encrypted - * @since POI 5.1.0 + * @since 5.1.0 * @see #setThresholdBytesForTempFiles(int) */ public static void setEncryptTempFiles(boolean encrypt) { @@ -80,7 +80,7 @@ public class ZipInputStreamZipEntrySource implements ZipEntrySource { /** * Whether temp files should be encrypted (default false). Only affects temp files related to zip entries. - * @since POI 5.1.0 + * @since 5.1.0 */ public static boolean shouldEncryptTempFiles() { return encryptTempFiles; diff --git a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipSecureFile.java b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipSecureFile.java index b5eb53a1cc..e6db1f4d0f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipSecureFile.java +++ b/poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipSecureFile.java @@ -93,7 +93,7 @@ public class ZipSecureFile extends ZipFile { * See setMaxFileCount() for details. * * @return The max accepted file count (i.e. the max number of files we allow inside zip files that we read - including OOXML files like xlsx, docx, pptx, etc.). - * @since POI 5.2.4 + * @since 5.2.4 */ public static long getMaxFileCount() { return MAX_FILE_COUNT; @@ -104,7 +104,7 @@ public class ZipSecureFile extends ZipFile { * including OOXML files like xlsx, docx, pptx, etc. The default is 1000. * * @param maxFileCount The max accepted file count - * @since POI 5.2.4 + * @since 5.2.4 */ public static void setMaxFileCount(final long maxFileCount) { MAX_FILE_COUNT = maxFileCount; @@ -151,7 +151,7 @@ public class ZipSecureFile extends ZipFile { * * @param graceEntrySize the grace entry size of a single zip entry * @throws IllegalArgumentException for negative graceEntrySize - * @since POI 5.2.4 + * @since 5.2.4 */ public static void setGraceEntrySize(long graceEntrySize) { if (graceEntrySize < 0) { @@ -167,7 +167,7 @@ public class ZipSecureFile extends ZipFile { * See setGraceEntrySize() for details. * * @return The current grace entry size - * @since POI 5.2.4 + * @since 5.2.4 */ public static long getGraceEntrySize() { return GRACE_ENTRY_SIZE; diff --git a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java index 18d62ca1fa..a3e585b521 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java +++ b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java @@ -232,14 +232,14 @@ public class SignatureConfig { /** * if true, the signature is added to the existing signatures * - * @since POI 4.1.0 + * @since 4.1.0 */ private boolean allowMultipleSignatures = false; /** * Switch to enable/disable secure validation - see setter for more information * - * @since POI 5.2.0 + * @since 5.2.0 */ private boolean secureValidation = true; @@ -249,7 +249,7 @@ public class SignatureConfig { * Switch to enable/disable automatic CRL download - by default the download is with all https hostname * and certificate verifications disabled. * - * @since POI 5.2.1 + * @since 5.2.1 */ private boolean allowCRLDownload = false; @@ -358,7 +358,7 @@ public class SignatureConfig { /** * @return the formatted execution time ({@link #SIGNATURE_TIME_FORMAT}) * - * @since POI 4.0.0 + * @since 4.0.0 */ public String formatExecutionTime() { final DateFormat fmt = new SimpleDateFormat(SIGNATURE_TIME_FORMAT, Locale.ROOT); @@ -370,7 +370,7 @@ public class SignatureConfig { * Sets the executionTime which is in standard format ({@link #SIGNATURE_TIME_FORMAT}) * @param executionTime the execution time * - * @since POI 4.0.0 + * @since 4.0.0 */ public void setExecutionTime(String executionTime) { if (executionTime != null && !executionTime.isEmpty()){ @@ -572,7 +572,7 @@ public class SignatureConfig { /** * @return the http client used for timestamp server connections * - * @since POI 5.2.1 + * @since 5.2.1 */ public TimeStampHttpClient getTspHttpClient() { return tspHttpClient; @@ -581,7 +581,7 @@ public class SignatureConfig { /** * @param tspHttpClient the http client used for timestamp server connections * - * @since POI 5.2.1 + * @since 5.2.1 */ public void setTspHttpClient(TimeStampHttpClient tspHttpClient) { this.tspHttpClient = tspHttpClient; @@ -664,7 +664,7 @@ public class SignatureConfig { * @param xadesDigestAlgo hash algorithm used for XAdES. * When {@code null}, defaults to {@link #getDigestAlgo()} * - * @since POI 4.0.0 + * @since 4.0.0 */ public void setXadesDigestAlgo(String xadesDigestAlgo) { this.xadesDigestAlgo = getDigestMethodAlgo(xadesDigestAlgo); @@ -925,7 +925,7 @@ public class SignatureConfig { * * @param signatureMethodUri the method uri * - * @since POI 4.0.0 + * @since 4.0.0 */ public void setSignatureMethodFromUri(final String signatureMethodUri) { switch (signatureMethodUri) { @@ -992,7 +992,7 @@ public class SignatureConfig { /** * @return true, if the signature config is to be updated based on the successful validated document * - * @since POI 4.0.0 + * @since 4.0.0 */ public boolean isUpdateConfigOnValidate() { return updateConfigOnValidate; @@ -1005,7 +1005,7 @@ public class SignatureConfig { * * @param updateConfigOnValidate if true, update config on validate * - * @since POI 4.0.0 + * @since 4.0.0 */ public void setUpdateConfigOnValidate(boolean updateConfigOnValidate) { this.updateConfigOnValidate = updateConfigOnValidate; @@ -1014,7 +1014,7 @@ public class SignatureConfig { /** * @return true, if multiple signatures can be attached * - * @since POI 4.1.0 + * @since 4.1.0 */ public boolean isAllowMultipleSignatures() { return allowMultipleSignatures; @@ -1026,7 +1026,7 @@ public class SignatureConfig { * @param allowMultipleSignatures if true, the signature will be added, * otherwise all existing signatures will be replaced by the current * - * @since POI 4.1.0 + * @since 4.1.0 */ public void setAllowMultipleSignatures(boolean allowMultipleSignatures) { this.allowMultipleSignatures = allowMultipleSignatures; @@ -1035,7 +1035,7 @@ public class SignatureConfig { /** * @return is secure validation enabled? * - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean isSecureValidation() { return secureValidation; @@ -1061,7 +1061,7 @@ public class SignatureConfig { * * @see XmlSec SecureValidation * - * @since POI 5.2.0 + * @since 5.2.0 */ public void setSecureValidation(boolean secureValidation) { this.secureValidation = secureValidation; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/XDDFLineProperties.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/XDDFLineProperties.java index f1aaea4ce7..07de8efa63 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/XDDFLineProperties.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/XDDFLineProperties.java @@ -37,7 +37,7 @@ public class XDDFLineProperties { /** * @param fill * fill properties to set on the new line properties. - * @since POI 4.0.2 + * @since 4.0.2 */ public XDDFLineProperties(XDDFFillProperties fill) { this(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFArea3DChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFArea3DChartData.java index 397b8d8854..a627576c94 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFArea3DChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFArea3DChartData.java @@ -151,7 +151,7 @@ public class XDDFArea3DChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTAreaSer getCTAreaSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFAreaChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFAreaChartData.java index a6488d7415..e8aec53baa 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFAreaChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFAreaChartData.java @@ -127,7 +127,7 @@ public class XDDFAreaChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTAreaSer getCTAreaSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBar3DChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBar3DChartData.java index b4ba523573..4f8ab5b302 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBar3DChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBar3DChartData.java @@ -198,7 +198,7 @@ public class XDDFBar3DChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTBarSer getCTBarSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBarChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBarChartData.java index 26c2069db7..5fba0b4447 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBarChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBarChartData.java @@ -188,7 +188,7 @@ public class XDDFBarChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTBarSer getCTBarSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBubbleChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBubbleChartData.java index a08eeb2b93..e8522822cd 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBubbleChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBubbleChartData.java @@ -32,7 +32,7 @@ import org.openxmlformats.schemas.drawingml.x2006.chart.CTSerTx; import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumData; /** - * @since POI 5.2.3 + * @since 5.2.3 */ @Beta public class XDDFBubbleChartData extends XDDFChartData { @@ -125,7 +125,7 @@ public class XDDFBubbleChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTBubbleSer getCTBubbleSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFCategoryAxis.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFCategoryAxis.java index a52b2a8970..50c4ff3754 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFCategoryAxis.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFCategoryAxis.java @@ -81,7 +81,7 @@ public class XDDFCategoryAxis extends XDDFChartAxis { } /** - * @since POI 4.0.2 + * @since 4.0.2 */ @Override public XDDFRunProperties getOrAddTextProperties() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChart.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChart.java index 4bfb948589..fba0620a07 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChart.java @@ -143,7 +143,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * the package part holding the chart data, the content type must * be * {@code application/vnd.openxmlformats-officedocument.drawingml.chart+xml} - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XDDFChart(PackagePart part) throws IOException, XmlException { super(part); @@ -186,7 +186,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * Clear all properties, as if a new instance had just been created. - * @since POI 4.1.2 + * @since 4.1.2 */ public void clear() { axes.clear(); @@ -322,7 +322,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * Remove the chart title. - * @since POI 5.0.0 + * @since 5.0.0 */ public void removeTitle() { setAutoTitleDeleted(true); @@ -500,7 +500,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * Clear all chart series, as if a new instance had just been created. - * @since POI 4.1.2 + * @since 4.1.2 */ public void clearChartSeries() { CTPlotArea plotArea = getCTPlotArea(); @@ -758,7 +758,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * index used to suffix on file * @return return relation part which used to write relation in .rels file * and get relation id - * @since POI 4.0.0 + * @since 4.0.0 */ public PackageRelationship createRelationshipInChart(POIXMLRelation chartRelation, POIXMLFactory chartFactory, int chartIndex) { @@ -775,7 +775,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param chartFactory * factory object of POIXMLFactory (XWPFFactory/XSLFFactory) * @return return the new package part - * @since POI 4.0.0 + * @since 4.0.0 */ private PackagePart createWorksheetPart(POIXMLRelation chartWorkbookRelation, POIXMLFactory chartFactory) throws InvalidFormatException { @@ -788,7 +788,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * this method write the XSSFWorkbook object data into embedded excel file * * @param workbook XSSFworkbook object - * @since POI 4.0.0 + * @since 4.0.0 */ public void saveWorkbook(XSSFWorkbook workbook) throws IOException, InvalidFormatException { PackagePart worksheetPart = getWorksheetPart(); @@ -810,21 +810,21 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * * @return the chart relation in the implementing subclass. - * @since POI 4.0.0 + * @since 4.0.0 */ protected abstract POIXMLRelation getChartRelation(); /** * * @return the chart workbook relation in the implementing subclass. - * @since POI 4.0.0 + * @since 4.0.0 */ protected abstract POIXMLRelation getChartWorkbookRelation(); /** * * @return the chart factory in the implementing subclass. - * @since POI 4.0.0 + * @since 4.0.0 */ protected abstract POIXMLFactory getChartFactory(); @@ -837,7 +837,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * category values * @param valuesData * data values - * @since POI 4.0.0 + * @since 4.0.0 */ protected void fillSheet(XSSFSheet sheet, XDDFDataSource categoryData, XDDFNumericalDataSource valuesData) { int numOfPoints = categoryData.getPointCount(); @@ -862,7 +862,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param index * index of current row * @return this method return sheet row on given index - * @since POI 4.0.0 + * @since 4.0.0 */ private XSSFRow getRow(XSSFSheet sheet, int index) { XSSFRow row = sheet.getRow(index); @@ -882,7 +882,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param index * index of current cell * @return this method return sheet cell on given index - * @since POI 4.0.0 + * @since 4.0.0 */ private XSSFCell getCell(XSSFRow row, int index) { XSSFCell cell = row.getCell(index); @@ -898,7 +898,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * * @param other * chart object - * @since POI 4.0.0 + * @since 4.0.0 */ public void importContent(XDDFChart other) { getCTChartSpace().set(other.getCTChartSpace()); @@ -935,7 +935,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param column * column index * @return return cell reference - * @since POI 4.0.0 + * @since 4.0.0 */ public CellReference setSheetTitle(String title, int column) { XSSFSheet sheet = getSheet(); @@ -950,7 +950,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai } /** - * @since POI 4.0.0 + * @since 4.0.0 */ public String formatRange(CellRangeAddress range) { final XSSFSheet sheet = getSheet(); @@ -961,7 +961,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * get sheet object of embedded excel file * * @return excel sheet object - * @since POI 4.0.0 + * @since 4.0.0 */ private XSSFSheet getSheet() { try { @@ -977,7 +977,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * writing xssfworkbook object into output stream of embedded part * * @return returns the packagepart of embedded file - * @since POI 4.0.0 + * @since 4.0.0 */ private PackagePart getWorksheetPart() throws InvalidFormatException { for (RelationPart part : getRelationParts()) { @@ -999,7 +999,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * @return returns the workbook object of embedded excel file - * @since POI 4.0.0 + * @since 4.0.0 */ public XSSFWorkbook getWorkbook() throws IOException, InvalidFormatException { if (workbook == null) { @@ -1028,7 +1028,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * * @param workbook * workbook object which we read from chart embedded part - * @since POI 4.0.0 + * @since 4.0.0 */ public void setWorkbook(XSSFWorkbook workbook) { this.workbook = workbook; @@ -1041,7 +1041,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param id * relation id of embedded excel relation id into external data * relation tag - * @since POI 4.0.0 + * @since 4.0.0 */ public void setExternalId(String id) { CTChartSpace ctChartSpace = getCTChartSpace(); @@ -1053,7 +1053,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai /** * @return method return chart index - * @since POI 4.0.0 + * @since 4.0.0 */ protected int getChartIndex() { return chartIndex; @@ -1075,7 +1075,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai * @param newSheet * sheet to be used in the data references. * - * @since POI 5.1.0 + * @since 5.1.0 */ public void replaceReferences(XSSFSheet newSheet) { for (XDDFChartData data : getChartSeries()) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartAxis.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartAxis.java index cac2864a4f..2ed30bcd45 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartAxis.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartAxis.java @@ -65,7 +65,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties { public abstract XDDFShapeProperties getOrAddMinorGridProperties(); /** - * @since POI 4.0.2 + * @since 4.0.2 */ public abstract XDDFRunProperties getOrAddTextProperties(); @@ -357,7 +357,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties { /** * @return tick label position. - * @since POI 4.0.2 + * @since 4.0.2 */ public AxisTickLabelPosition getTickLabelPosition() { return AxisTickLabelPosition.valueOf(getCTTickLblPos().getVal()); @@ -366,7 +366,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties { /** * @param labelPosition * tick label position. - * @since POI 4.0.2 + * @since 4.0.2 */ public void setTickLabelPosition(AxisTickLabelPosition labelPosition) { getCTTickLblPos().setVal(labelPosition.underlying); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartData.java index 983ef4f138..dec3951254 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartData.java @@ -159,7 +159,7 @@ public abstract class XDDFChartData { /** * Set the Chart Series title. * @param title chart series title - * @since POI 5.2.3 + * @since 5.2.3 */ public void setTitle(String title) { setTitle(title, null); @@ -224,7 +224,7 @@ public abstract class XDDFChartData { /** * @param fill * fill property for the shape representing the series. - * @since POI 4.1.1 + * @since 4.1.1 */ public void setFillProperties(XDDFFillProperties fill) { XDDFShapeProperties properties = getShapeProperties(); @@ -238,7 +238,7 @@ public abstract class XDDFChartData { /** * @param line * line property for the shape representing the series. - * @since POI 4.1.1 + * @since 4.1.1 */ public void setLineProperties(XDDFLineProperties line) { XDDFShapeProperties properties = getShapeProperties(); @@ -255,7 +255,7 @@ public abstract class XDDFChartData { * * @param index * data point index. - * @since POI 5.1.0 + * @since 5.1.0 */ public void clearDataPoint(long index) { List points = getDPtList(); @@ -275,7 +275,7 @@ public abstract class XDDFChartData { * data point index. * @return * the data point with the given {@code index}. - * @since POI 5.1.0 + * @since 5.1.0 */ public XDDFDataPoint getDataPoint(long index) { List points = getDPtList(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSource.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSource.java index ea99a34b12..229e505bf6 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSource.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSource.java @@ -33,12 +33,12 @@ public interface XDDFDataSource { T getPointAt(int index); /** - * @since POI 4.0.2 + * @since 4.0.2 */ boolean isLiteral(); /** - * @since POI 4.1.2 + * @since 4.1.2 */ boolean isCellRange(); @@ -57,7 +57,7 @@ public interface XDDFDataSource { String getFormatCode(); /** - * @since POI 5.0.0 + * @since 5.0.0 */ @Internal default void fillNumericalCache(CTNumData cache) { @@ -95,7 +95,7 @@ public interface XDDFDataSource { } /** - * @since POI 4.1.2 + * @since 4.1.2 */ @Internal default void fillStringCache(CTStrData cache) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDateAxis.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDateAxis.java index 00722ea02a..1c111eb05d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDateAxis.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDateAxis.java @@ -85,7 +85,7 @@ public class XDDFDateAxis extends XDDFChartAxis { } /** - * @since POI 4.0.2 + * @since 4.0.2 */ @Override public XDDFRunProperties getOrAddTextProperties() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDoughnutChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDoughnutChartData.java index 56137092f6..ecfe82e2fb 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDoughnutChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDoughnutChartData.java @@ -138,7 +138,7 @@ public class XDDFDoughnutChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTPieSer getCTPieSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFErrorBars.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFErrorBars.java index 108793d0ce..05f271762d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFErrorBars.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFErrorBars.java @@ -27,7 +27,7 @@ import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource; import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumRef; /** - * @since POI 4.1.2 + * @since 4.1.2 */ @Beta public class XDDFErrorBars { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLine3DChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLine3DChartData.java index 68a60bcfc5..5fc8990483 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLine3DChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLine3DChartData.java @@ -142,7 +142,7 @@ public class XDDFLine3DChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTLineSer getCTLineSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLineChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLineChartData.java index 5e9e51d757..a138f1acf5 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLineChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLineChartData.java @@ -117,7 +117,7 @@ public class XDDFLineChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTLineSer getCTLineSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPie3DChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPie3DChartData.java index 95670cf63d..ccbdcd6e31 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPie3DChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPie3DChartData.java @@ -87,7 +87,7 @@ public class XDDFPie3DChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTPieSer getCTPieSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPieChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPieChartData.java index 3d69e0f163..170a418b9d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPieChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPieChartData.java @@ -117,7 +117,7 @@ public class XDDFPieChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTPieSer getCTPieSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFRadarChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFRadarChartData.java index 4693773c27..822b06b61d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFRadarChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFRadarChartData.java @@ -117,7 +117,7 @@ public class XDDFRadarChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTRadarSer getCTRadarSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFScatterChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFScatterChartData.java index 1bf6ead501..1d3f24025c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFScatterChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFScatterChartData.java @@ -122,7 +122,7 @@ public class XDDFScatterChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTScatterSer getCTScatterSer() { return series; @@ -205,35 +205,35 @@ public class XDDFScatterChartData extends XDDFChartData { } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public int getErrorBarsCount() { return series.sizeOfErrBarsArray(); } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public XDDFErrorBars getErrorBars(int index) { return new XDDFErrorBars(series.getErrBarsArray(index)); } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public XDDFErrorBars addNewErrorBars() { return new XDDFErrorBars(series.addNewErrBars()); } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public XDDFErrorBars insertNewErrorBars(int index) { return new XDDFErrorBars(series.insertNewErrBars(index)); } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public void removeErrorBars(int index) { series.removeErrBars(index); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSeriesAxis.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSeriesAxis.java index df0297e288..3a365834e7 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSeriesAxis.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSeriesAxis.java @@ -81,7 +81,7 @@ public class XDDFSeriesAxis extends XDDFChartAxis { } /** - * @since POI 4.0.2 + * @since 4.0.2 */ @Override public XDDFRunProperties getOrAddTextProperties() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurface3DChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurface3DChartData.java index 41c9700797..00c3bdc671 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurface3DChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurface3DChartData.java @@ -124,7 +124,7 @@ public class XDDFSurface3DChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTSurfaceSer getCTSurfaceSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurfaceChartData.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurfaceChartData.java index 8e5e755882..f9aac00f5b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurfaceChartData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurfaceChartData.java @@ -129,7 +129,7 @@ public class XDDFSurfaceChartData extends XDDFChartData { } /** - * @since POI 5.2.3 + * @since 5.2.3 */ public CTSurfaceSer getCTSurfaceSer() { return series; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFTitle.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFTitle.java index fedd3f3d50..b18aa738ab 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFTitle.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFTitle.java @@ -85,7 +85,7 @@ public class XDDFTitle { } /** - * @since POI 4.1.2 + * @since 4.1.2 */ public XDDFRunProperties getOrAddTextProperties() { CTTextBody text; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFValueAxis.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFValueAxis.java index 9189a65f74..c144464ce8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFValueAxis.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFValueAxis.java @@ -81,7 +81,7 @@ public class XDDFValueAxis extends XDDFChartAxis { } /** - * @since POI 4.0.2 + * @since 4.0.2 */ @Override public XDDFRunProperties getOrAddTextProperties() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/text/XDDFTextParagraph.java b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/text/XDDFTextParagraph.java index 9f8b581c80..c910328421 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/text/XDDFTextParagraph.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/text/XDDFTextParagraph.java @@ -122,7 +122,7 @@ public class XDDFTextParagraph implements Iterable { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFBaseContents.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFBaseContents.java index 9559cce58b..58b26440ae 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFBaseContents.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFBaseContents.java @@ -52,7 +52,7 @@ public class XDGFBaseContents extends XDGFXMLDocumentPart { protected List _connections = new ArrayList<>(); /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFBaseContents(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFFactory.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFFactory.java index 6cd39cb785..63ab4cf04f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFFactory.java @@ -35,7 +35,7 @@ public class XDGFFactory extends POIXMLFactory { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected POIXMLRelation getDescriptor(String relationshipType) { return XDGFRelation.getInstance(relationshipType); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasterContents.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasterContents.java index b357e5cb43..b0f4d9def3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasterContents.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasterContents.java @@ -34,7 +34,7 @@ public class XDGFMasterContents extends XDGFBaseContents { protected XDGFMaster _master; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFMasterContents(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasters.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasters.java index 315c5921b4..07c6cd8784 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasters.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasters.java @@ -48,7 +48,7 @@ public class XDGFMasters extends XDGFXMLDocumentPart { protected Map _masters = new HashMap<>(); /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFMasters(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPageContents.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPageContents.java index 413c9bb9e6..59b8c6a766 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPageContents.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPageContents.java @@ -35,7 +35,7 @@ public class XDGFPageContents extends XDGFBaseContents { protected XDGFPage _page; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFPageContents(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPages.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPages.java index 4e50cad597..43232c05c8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPages.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPages.java @@ -47,7 +47,7 @@ public class XDGFPages extends XDGFXMLDocumentPart { List _pages = new ArrayList<>(); /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFPages(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java index e6195a8578..ed7825d31f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java @@ -93,7 +93,7 @@ public class XmlVisioDocument extends POIXMLDocument { * @param stream InputStream * @param closeStream Whether to close the InputStream * @throws IOException If parsing the document fails - * @since POI 5.2.5 + * @since 5.2.5 */ public XmlVisioDocument(InputStream stream, boolean closeStream) throws IOException { this(PackageHelper.open(stream, closeStream)); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xdgf/xml/XDGFXMLDocumentPart.java b/poi-ooxml/src/main/java/org/apache/poi/xdgf/xml/XDGFXMLDocumentPart.java index 51409a40de..0032ec1403 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xdgf/xml/XDGFXMLDocumentPart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xdgf/xml/XDGFXMLDocumentPart.java @@ -26,14 +26,14 @@ public class XDGFXMLDocumentPart extends POIXMLDocumentPart { protected XDGFDocument _document; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XDGFXMLDocumentPart(PackagePart part) { super(part); } /** - * @since POI 4.1.2 + * @since 4.1.2 */ @Internal public void setDocument(XDGFDocument document) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFParser.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFParser.java index cd113f44bf..19c17b0325 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFParser.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFParser.java @@ -32,7 +32,7 @@ import org.apache.poi.xslf.usermodel.XMLSlideShow; * throw {@link XSLFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class XSLFParser { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFReadException.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFReadException.java index e26900cde8..e0430b5043 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFReadException.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class XSLFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java index 0def14f8ce..63cea1a76c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java @@ -151,7 +151,7 @@ public class XMLSlideShow extends POIXMLDocument * @throws POIXMLException a RuntimeException that can be caused by invalid OOXML data * @throws IllegalStateException a number of other runtime exceptions can be thrown, especially if there are problems with the * input format - * @since POI 5.2.5 + * @since 5.2.5 */ public XMLSlideShow(InputStream stream, boolean closeStream) throws IOException { this(PackageHelper.open(stream, closeStream)); @@ -341,7 +341,7 @@ public class XMLSlideShow extends POIXMLDocument /** * This method is used to create template for chart XML. * @return Xslf chart object - * @since POI 4.1.0 + * @since 4.1.0 */ public XSLFChart createChart() { int chartIdx = findNextAvailableFileNameIndex(XSLFRelation.CHART); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFChart.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFChart.java index 1d35c72374..1e528db97e 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFChart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFChart.java @@ -62,7 +62,7 @@ public final class XSLFChart extends XDDFChart { * * @param part the package part holding the chart data, * the content type must be application/vnd.openxmlformats-officedocument.drawingml.chart+xml - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSLFChart(PackagePart part) throws IOException, XmlException { super(part); @@ -112,7 +112,7 @@ public final class XSLFChart extends XDDFChart { * @param rID relation id * @param anchor size and location of chart * @return graphic frame object - * @since POI 4.1.0 + * @since 4.1.0 */ static CTGraphicalObjectFrame prototype(int shapeId, String rID, Rectangle2D anchor) { CTGraphicalObjectFrame frame = CTGraphicalObjectFrame.Factory.newInstance(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComment.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComment.java index 9abc38ebe8..84457894d0 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComment.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComment.java @@ -33,7 +33,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.CTCommentAuthorList; /** * XSLF Comment * - * @since POI 4.0.0 + * @since 4.0.0 */ public class XSLFComment implements Comment { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFCommentAuthors.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFCommentAuthors.java index 4ee910d809..bf4c71f8b3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFCommentAuthors.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFCommentAuthors.java @@ -49,7 +49,7 @@ public class XSLFCommentAuthors extends POIXMLDocumentPart { * @param part the package part holding the comment authors data, * the content type must be application/vnd.openxmlformats-officedocument.commentAuthors+xml * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ XSLFCommentAuthors(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComments.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComments.java index c34a6ee3d5..9a3055040a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComments.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComments.java @@ -46,7 +46,7 @@ public class XSLFComments extends POIXMLDocumentPart { * * @param part the package part holding the comments data, * the content type must be application/vnd.openxmlformats-officedocument.comments+xml - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ XSLFComments(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDiagram.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDiagram.java index 2d14b4f13c..6c89bc8b7f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDiagram.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDiagram.java @@ -68,7 +68,7 @@ import java.util.List; * how to render the diagram. Rendering diagrams from these files is not trivial, they support for loops, if/elses, etc. * Integrating such a change into POI would be quite sophisticated and challenging. * - * @since POI 5.2.3 + * @since 5.2.3 */ @Beta public class XSLFDiagram extends XSLFGraphicFrame { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDrawing.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDrawing.java index ab063a8bcb..9291ffe31f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDrawing.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDrawing.java @@ -113,7 +113,7 @@ public class XSLFDrawing { * * @param rID relation id of chart * @param rect2D Chart Bounding values - * @since POI 4.1.0 + * @since 4.1.0 */ public void addChart(String rID, Rectangle2D rect2D) { CTGraphicalObjectFrame sp = _spTree.addNewGraphicFrame(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFactory.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFactory.java index e6b27e62ea..3c806968d3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFactory.java @@ -35,7 +35,7 @@ public final class XSLFFactory extends POIXMLFactory { private XSLFFactory() {} /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Override protected POIXMLRelation getDescriptor(String relationshipType) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontData.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontData.java index 0c2e5efa29..effb0d752c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontData.java @@ -31,7 +31,7 @@ import org.apache.poi.util.Beta; * A container for fontdata files, i.e. MTX fonts derived from * true (TTF) or open (OTF) type fonts. * - * @since POI 4.1.0 + * @since 4.1.0 */ @Beta public class XSLFFontData extends POIXMLDocumentPart { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontInfo.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontInfo.java index 2d37f925bc..3addddbb92 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontInfo.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontInfo.java @@ -255,7 +255,7 @@ public class XSLFFontInfo implements FontInfo { * @return a font data object * @throws IOException if the font data can't be stored * - * @since POI 4.1.0 + * @since 4.1.0 */ public static XSLFFontInfo addFontToSlideShow(XMLSlideShow ppt, InputStream fontStream) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java index e52ae20054..983b9decb0 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java @@ -194,7 +194,7 @@ public class XSLFGraphicFrame extends XSLFShape implements GraphicalFrame { * @param part the package part holding the notes data, * the content type must be application/vnd.openxmlformats-officedocument.notes+xml * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ XSLFNotes(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotesMaster.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotesMaster.java index fd1cbfb21c..8cb612c30e 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotesMaster.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotesMaster.java @@ -54,7 +54,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.NotesMasterDocument; } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSLFNotesMaster(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFObjectData.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFObjectData.java index dee50bc116..80950db6d0 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFObjectData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFObjectData.java @@ -47,7 +47,7 @@ public final class XSLFObjectData extends POIXMLDocumentPart implements ObjectDa * * @param part the package part holding the ole data * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSLFObjectData(final PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureData.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureData.java index 82daee8dbe..e7eea4f513 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureData.java @@ -80,7 +80,7 @@ public final class XSLFPictureData extends POIXMLDocumentPart implements Picture * * @param part the package part holding the drawing data * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSLFPictureData(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java index 4cb437c5f1..f87beb78e4 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java @@ -229,7 +229,7 @@ public class XSLFPictureShape extends XSLFSimpleShape * Add a SVG image reference * @param svgPic a previously imported svg image * - * @since POI 4.1.0 + * @since 4.1.0 */ public void setSvgImage(XSLFPictureData svgPic) { CTBlip blip = getBlip(); @@ -275,7 +275,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @return picture name, can be null - * @since POI 5.1.0 + * @since 5.1.0 */ public String getName() { String name = null; @@ -292,7 +292,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @param name picture name * @return returns true if the name was set - * @since POI 5.1.0 + * @since 5.1.0 */ public boolean setName(String name) { XmlObject xmlObject = getXmlObject(); @@ -349,7 +349,7 @@ public class XSLFPictureShape extends XSLFSimpleShape * @param anchor the image anchor (for calculating the preview image size) or * null (the preview size is taken from the svg picture bounds) * - * @since POI 4.1.0 + * @since 4.1.0 */ public static XSLFPictureShape addSvgImage(XSLFSheet sheet, XSLFPictureData svgPic, PictureType previewType, Rectangle2D anchor) throws IOException { @@ -439,7 +439,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @return boolean; true if the picture is a video - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean isVideoFile() { CTPictureNonVisual nvPicPr = getCTPictureNonVisual(); @@ -454,7 +454,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @return the link ID for the video file - * @since POI 5.2.0 + * @since 5.2.0 */ public String getVideoFileLink() { if (isVideoFile()) { @@ -476,7 +476,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @return boolean; true if the picture is an audio - * @since POI 5.2.4 + * @since 5.2.4 */ public boolean isAudioFile() { CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing(); @@ -485,7 +485,7 @@ public class XSLFPictureShape extends XSLFSimpleShape /** * @return the link ID for the audio file - * @since POI 5.2.4 + * @since 5.2.4 */ public String getAudioFileLink() { CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPlaceholderDetails.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPlaceholderDetails.java index ce75a19f61..9beb83815b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPlaceholderDetails.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPlaceholderDetails.java @@ -40,7 +40,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.STPlaceholderType; /** * XSLF Placeholder Details * - * @since POI 4.0.0 + * @since 4.0.0 */ public class XSLFPlaceholderDetails implements PlaceholderDetails { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPropertiesDelegate.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPropertiesDelegate.java index 9faba886eb..e4c97b22ef 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPropertiesDelegate.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPropertiesDelegate.java @@ -46,7 +46,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.CTBackgroundProperti * This class is experimental and not (yet) supposed for public usage. * Maybe the xml schemas might be enhanced with interfaces to make this class superfluous * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ @Internal /* package */ class XSLFPropertiesDelegate { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java index 37c853b83e..9b9ed2aa77 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java @@ -93,7 +93,7 @@ implements XSLFShapeContainer, Sheet { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSLFSheet(PackagePart part) { super(part); @@ -719,7 +719,7 @@ implements XSLFShapeContainer, Sheet { * this method will add chart into slide * with default height, width, x and y * @param chart xslf chart object - * @since POI 4.1.0 + * @since 4.1.0 */ public void addChart(XSLFChart chart) { Rectangle2D rect2D = new Rectangle(XDDFChart.DEFAULT_X, XDDFChart.DEFAULT_Y, @@ -732,7 +732,7 @@ implements XSLFShapeContainer, Sheet { * this method will add chart into slide * with given height, width, x and y * @param chart xslf chart object - * @since POI 4.1.0 + * @since 4.1.0 */ public void addChart(XSLFChart chart, Rectangle2D rect2D) { RelationPart rp = addRelation(null, XSLFRelation.CHART, chart); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java index 2e213b9de6..29c51cacb3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java @@ -73,7 +73,7 @@ implements Slide { * @param part the package part holding the slide data, * the content type must be {@code application/vnd.openxmlformats-officedocument.slide+xml} * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ XSLFSlide(PackagePart part) throws IOException, XmlException { super(part); @@ -165,7 +165,7 @@ implements Slide { /** * @return the comments part or {@code null} if there weren't any comments - * @since POI 4.0.0 + * @since 4.0.0 */ @SuppressWarnings("WeakerAccess") public XSLFComments getCommentsPart() { @@ -183,7 +183,7 @@ implements Slide { /** * @return the comment authors part or {@code null} if there weren't any comments - * @since POI 4.0.0 + * @since 4.0.0 */ @SuppressWarnings("WeakerAccess") public XSLFCommentAuthors getCommentAuthorsPart() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideLayout.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideLayout.java index 0d6b9ca476..cceea347d9 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideLayout.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideLayout.java @@ -39,7 +39,7 @@ implements MasterSheet { private XSLFSlideMaster _master; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSLFSlideLayout(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideMaster.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideMaster.java index 0031225e75..ea0f49abef 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideMaster.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideMaster.java @@ -58,7 +58,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.SldMasterDocument; private Map _layouts; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSLFSlideMaster(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTable.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTable.java index 3434788c24..eb02744437 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTable.java @@ -170,7 +170,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable { /** * Insert a new cell at the given index. * @param colIdx the column index. - * @since POI 4.1.2 + * @since 4.1.2 */ public XSLFTableCell insertCell(int colIdx){ CTTableCell c = _row.insertNewTc(colIdx); @@ -102,7 +102,7 @@ public class XSLFTableRow implements Iterable { /** * Remove the cell at the given index. * @param colIdx the column index. - * @since POI 4.1.2 + * @since 4.1.2 */ public void removeCell(int colIdx){ if (_row.sizeOfTcArray() < colIdx) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyle.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyle.java index 6d4372c21a..81ad1a6a9e 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyle.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyle.java @@ -49,7 +49,7 @@ public class XSLFTableStyle { } /** - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ protected CTTablePartStyle getTablePartStyle(TablePartStyle tps) { switch (tps) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyles.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyles.java index e2100e81fd..737a0d213c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyles.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyles.java @@ -41,7 +41,7 @@ public class XSLFTableStyles extends POIXMLDocumentPart implements Iterable { @@ -130,7 +130,7 @@ public class XSLFTextParagraph implements TextParagraph spliterator() { @@ -239,7 +239,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape /** * @param paragraph paragraph to remove * @return whether the paragraph was removed - * @since POI 5.2.2 + * @since 5.2.2 */ public boolean removeTextParagraph(XSLFTextParagraph paragraph) { CTTextParagraph ctTextParagraph = paragraph.getXmlObject(); @@ -807,7 +807,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape * * @return a new text paragraph * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ protected XSLFTextParagraph newTextParagraph(CTTextParagraph p) { return new XSLFTextParagraph(p, this); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTheme.java b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTheme.java index 002f2a3fa5..dccd7c1c6d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTheme.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTheme.java @@ -48,7 +48,7 @@ public class XSLFTheme extends POIXMLDocumentPart { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSLFTheme(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFParser.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFParser.java index e56c71da99..3b14d18a9c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFParser.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFParser.java @@ -31,7 +31,7 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook; * throw {@link XSSFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class XSSFParser { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFReadException.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFReadException.java index f2dbac32c9..f71ceda41d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFReadException.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class XSSFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java index 24676ac7b9..8f8a7d2a93 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java @@ -69,7 +69,7 @@ public class XSSFBSheetHandler extends XSSFBParser { * @param comments optional comments table, may be {@code null} * @param strings shared strings table used by the sheet * @param sheetContentsHandler callback receiving native cell events - * @since POI 5.5.0 + * @since 5.5.0 */ public XSSFBSheetHandler(InputStream is, XSSFBStylesTable styles, @@ -414,7 +414,7 @@ public class XSSFBSheetHandler extends XSSFBParser { * Receives streaming callbacks while {@link XSSFBSheetHandler} parses an XLSB sheet. * * @see XSSFBSheetHandler - * @since POI 5.5.0 + * @since 5.5.0 */ public interface XSSFBSheetContentsHandler { /** diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java index bbdd30915c..f76ba8c8b5 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java @@ -118,7 +118,7 @@ public class ReadOnlySharedStringsTable extends DefaultHandler implements Shared * * @param pkg The {@link OPCPackage} to use as basis for the shared-strings table. * @param includePhoneticRuns whether or not to concatenate phoneticRuns onto the shared string - * @since POI 3.14-Beta3 + * @since 3.14-Beta3 * @throws IOException If reading the data from the package fails. * @throws SAXException if parsing the XML data fails. */ @@ -143,14 +143,14 @@ public class ReadOnlySharedStringsTable extends DefaultHandler implements Shared * Calls {@link #ReadOnlySharedStringsTable(PackagePart, boolean)}, with a * value of true to include phonetic runs. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public ReadOnlySharedStringsTable(PackagePart part) throws IOException, SAXException { this(part, true); } /** - * @since POI 3.14-Beta3 + * @since 3.14-Beta3 */ public ReadOnlySharedStringsTable(PackagePart part, boolean includePhoneticRuns) throws IOException, SAXException { @@ -161,7 +161,7 @@ public class ReadOnlySharedStringsTable extends DefaultHandler implements Shared } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public ReadOnlySharedStringsTable(InputStream stream) throws IOException, SAXException { @@ -169,7 +169,7 @@ public class ReadOnlySharedStringsTable extends DefaultHandler implements Shared } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public ReadOnlySharedStringsTable(InputStream stream, boolean includePhoneticRuns) throws IOException, SAXException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFBReader.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFBReader.java index f3f2b1cfc3..6d5ed309ba 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFBReader.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFBReader.java @@ -107,7 +107,7 @@ public class XSSFBReader extends XSSFReader { * @return iterator of {@link InputStream}s * @throws InvalidFormatException if the sheet data format is invalid * @throws IOException if there is an I/O issue reading the data - * @since POI 5.4.0 + * @since 5.4.0 */ @Override public SheetIterator getSheetIterator() throws IOException, InvalidFormatException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java index 09e4c1df77..de4dbb207c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java @@ -127,7 +127,7 @@ public class XSSFReader { * * @param useReadOnlySharedStringsTable if true, the ReadOnlySharedStringsTable is used, * SharedStringsTable otherwise - * @since POI 5.2.0 + * @since 5.2.0 */ public void setUseReadOnlySharedStringsTable(boolean useReadOnlySharedStringsTable) { this.useReadOnlySharedStringsTable = useReadOnlySharedStringsTable; @@ -136,7 +136,7 @@ public class XSSFReader { /** * @return whether {@link #getSharedStringsTable()} uses {@link SharedStringsTable} * or {@link ReadOnlySharedStringsTable}. - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean useReadOnlySharedStringsTable() { return useReadOnlySharedStringsTable; @@ -280,7 +280,7 @@ public class XSSFReader { * * @throws InvalidFormatException if the sheet data format is invalid * @throws IOException if there is an I/O issue reading the data - * @since POI 5.4.0 + * @since 5.4.0 */ public SheetIterator getSheetIterator() throws IOException, InvalidFormatException { return new SheetIterator(workbookPart); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CalculationChain.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CalculationChain.java index 1a3bafcac6..cc439b2317 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CalculationChain.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CalculationChain.java @@ -42,7 +42,7 @@ public class CalculationChain extends POIXMLDocumentPart { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public CalculationChain(PackagePart part) throws IOException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java index 72f7b114af..27cd15151d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java @@ -35,7 +35,7 @@ public interface Comments { * This method is for internal POI use only. POI uses it to link the sheet and comments table. * This method will not move comments from one sheet to another (if a user tries to use this method for that purpose). * @param sheet the sheet that this comments table is associated with - * @since POI 5.2.0 + * @since 5.2.0 */ @Internal void setSheet(Sheet sheet); @@ -75,7 +75,7 @@ public interface Comments { * Create a new comment and add to the CommentTable. * @param clientAnchor the anchor for this comment * @return new XSSFComment - * @since POI 5.2.0 + * @since 5.2.0 */ XSSFComment createNewComment(ClientAnchor clientAnchor); @@ -85,7 +85,7 @@ public interface Comments { * @param oldReference the comment to remove from the commentRefs map * @param comment the comment to replace in the commentRefs map * @see #commentUpdated(XSSFComment) - * @since POI 5.2.0 + * @since 5.2.0 */ void referenceUpdated(CellAddress oldReference, XSSFComment comment); @@ -93,7 +93,7 @@ public interface Comments { * Called after the comment is updated, so that * we can reflect that in our cache * @param comment the comment to replace in the commentRefs map - * @since POI 5.2.0 + * @since 5.2.0 * @see #referenceUpdated(CellAddress, XSSFComment) */ void commentUpdated(XSSFComment comment); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java index 46c895e415..f449d5951c 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java @@ -71,7 +71,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public CommentsTable(PackagePart part) throws IOException { super(part); @@ -115,7 +115,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { * @param oldReference the comment to remove from the commentRefs map * @param comment the comment to replace in the commentRefs map * @see #commentUpdated(XSSFComment) - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public void referenceUpdated(CellAddress oldReference, XSSFComment comment) { @@ -129,7 +129,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { * Called after the comment is updated, so that * we can reflect that in our cache * @param comment the comment to replace in the commentRefs map - * @since POI 5.2.0 + * @since 5.2.0 * @see #referenceUpdated(CellAddress, XSSFComment) */ @Override @@ -211,7 +211,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { * Create a new comment and add to the CommentTable. * @param clientAnchor the anchor for this comment * @return new XSSFComment - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public XSSFComment createNewComment(ClientAnchor clientAnchor) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ExternalLinksTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ExternalLinksTable.java index 45568a23af..70d3b3b4ac 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ExternalLinksTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ExternalLinksTable.java @@ -58,7 +58,7 @@ public class ExternalLinksTable extends POIXMLDocumentPart { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public ExternalLinksTable(PackagePart part) throws IOException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/MapInfo.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/MapInfo.java index b7f3d71a12..46eee39c36 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/MapInfo.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/MapInfo.java @@ -59,7 +59,7 @@ public class MapInfo extends POIXMLDocumentPart { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public MapInfo(PackagePart part) throws IOException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SharedStringsTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SharedStringsTable.java index b83f5f297e..d5e0bed814 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SharedStringsTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SharedStringsTable.java @@ -104,7 +104,7 @@ public class SharedStringsTable extends POIXMLDocumentPart implements SharedStri } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public SharedStringsTable(PackagePart part) throws IOException { super(part); @@ -213,7 +213,7 @@ public class SharedStringsTable extends POIXMLDocumentPart implements SharedStri *

* * @param string the entry to add - * @since POI 4.0.0 + * @since 4.0.0 * @return index the index of added entry */ public int addSharedStringItem(RichTextString string) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SingleXmlCells.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SingleXmlCells.java index f66d919677..8921960d45 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SingleXmlCells.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/SingleXmlCells.java @@ -52,7 +52,7 @@ public class SingleXmlCells extends POIXMLDocumentPart { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public SingleXmlCells(PackagePart part) throws IOException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/StylesTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/StylesTable.java index 1eb86f2f82..a4cd687fad 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/StylesTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/StylesTable.java @@ -151,7 +151,7 @@ public class StylesTable extends POIXMLDocumentPart implements Styles { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public StylesTable(PackagePart part) throws IOException { super(part); @@ -161,7 +161,7 @@ public class StylesTable extends POIXMLDocumentPart implements Styles { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public StylesTable(InputStream stream) throws IOException { super(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ThemesTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ThemesTable.java index 4d6655d5fc..f9141284c5 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ThemesTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/ThemesTable.java @@ -81,7 +81,7 @@ public class ThemesTable extends POIXMLDocumentPart implements Themes { * Construct a ThemesTable. * @param part A PackagePart. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public ThemesTable(PackagePart part) throws IOException { super(part); @@ -94,7 +94,7 @@ public class ThemesTable extends POIXMLDocumentPart implements Themes { * Construct a ThemesTable. * @param stream input stream. * - * @since POI 5.2.0 + * @since 5.2.0 */ public ThemesTable(InputStream stream) throws IOException { super(); @@ -114,7 +114,7 @@ public class ThemesTable extends POIXMLDocumentPart implements Themes { * * @param is The input stream containing the XML document. * @throws IOException if an error occurs while reading. - * @since POI 5.2.0 + * @since 5.2.0 */ public void readFrom(InputStream is) throws IOException { try { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java index 76c966f8bd..c120e05a8a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java @@ -64,7 +64,7 @@ public class SXSSFCell extends CellBase { * @param row the {@link SXSSFRow} * @param cellType the {@link CellType} * @param columnIndex the column index (zero based) - * @since POI 5.2.4 + * @since 5.2.4 */ public SXSSFCell(final SXSSFRow row, final CellType cellType, final int columnIndex) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFDrawing.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFDrawing.java index c75265a4db..513e1676ef 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFDrawing.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFDrawing.java @@ -69,7 +69,7 @@ public class SXSSFDrawing implements Drawing { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java index 3f19893da8..2af59fb92b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java @@ -38,7 +38,7 @@ final class SXSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#getlastRowNum() - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public int getLastRowNum() { @@ -47,7 +47,7 @@ final class SXSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#isRowHidden(int) - * @since POI 4.1.0 + * @since 4.1.0 */ @Override public boolean isRowHidden(int rowIndex) { @@ -73,7 +73,7 @@ final class SXSSFEvaluationSheet implements EvaluationSheet { } /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java index 91a579032b..0a3bb81b25 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFRow.java @@ -437,7 +437,7 @@ public class SXSSFRow implements Row, Comparable * Throws ConcurrentModificationException if cells are added, moved, or * removed after the spliterator is created. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java index bdb87f1bad..9ac5399f45 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java @@ -385,7 +385,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * @param autoCreate if true, then a new VML drawing part is created * * @return the VML drawing of {@code null} if the drawing was not found and autoCreate=false - * @since POI 5.2.0 + * @since 5.2.0 */ public XSSFVMLDrawing getVMLDrawing(boolean autoCreate) { XSSFSheet xssfSheet = getWorkbook().getXSSFSheet(this); @@ -550,7 +550,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * @return a spliterator of the PHYSICAL rows. Meaning the 3rd element may not * be the third row if say for instance the second row is undefined. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") @@ -841,7 +841,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * * @param margin which margin to get * @return the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public double getMargin(PageMargin margin) { @@ -873,7 +873,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * * @param margin which margin to set * @param size the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setMargin(PageMargin margin, double size) { @@ -1087,7 +1087,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * @param leftmostColumn Left column visible in right pane. * @param activePane Active pane. * @see PaneType - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, PaneType activePane) { @@ -1717,7 +1717,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * * @param addr The address of the cell containing the hyperlink * @return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public XSSFHyperlink getHyperlink(CellAddress addr) { @@ -1732,7 +1732,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions { * explicitly cell the value, eg B2 or B2:C3 (the 4 cells with B2 at top left and C3 at bottom right) * * @param hyperlink the link to add - * @since POI 5.2.3 + * @since 5.2.3 */ public void addHyperlink(XSSFHyperlink hyperlink) { _sh.addHyperlink(hyperlink); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java index 1730e46443..28dd430c2f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java @@ -361,7 +361,7 @@ public class SXSSFWorkbook implements Workbook { /** * @param shouldCalculateSheetDimensions defaults to true, set to false if * the calculated dimensions are causing trouble - * @since POI 5.2.3 + * @since 5.2.3 */ public void setShouldCalculateSheetDimensions(boolean shouldCalculateSheetDimensions) { this.shouldCalculateSheetDimensions = shouldCalculateSheetDimensions; @@ -370,7 +370,7 @@ public class SXSSFWorkbook implements Workbook { /** * @return shouldCalculateSheetDimensions defaults to true, set to false if * the calculated dimensions are causing trouble - * @since POI 5.2.3 + * @since 5.2.3 */ public boolean shouldCalculateSheetDimensions() { return shouldCalculateSheetDimensions; @@ -755,7 +755,7 @@ public class SXSSFWorkbook implements Workbook { * * @return a spliterator of the sheets. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { @@ -970,7 +970,7 @@ public class SXSSFWorkbook implements Workbook { * * @param stream - the java OutputStream you wish to write to * @throws IOException if anything can't be written. - * @since POI 5.1.0 (experimental and still liable to change or be removed) + * @since 5.1.0 (experimental and still liable to change or be removed) */ @Beta public void writeAvoidingTempFiles(OutputStream stream) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java index c4a4673571..7c65d8f508 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java @@ -63,7 +63,7 @@ public abstract class BaseXSSFEvaluationWorkbook implements FormulaRenderingWork } /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/OoxmlSheetExtensions.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/OoxmlSheetExtensions.java index 6d5d33582a..bd17aa9e8b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/OoxmlSheetExtensions.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/OoxmlSheetExtensions.java @@ -22,7 +22,7 @@ import org.apache.poi.ss.usermodel.Sheet; /** * Methods exposed by XSSF, SXSSF and related sheets - that are additional to the ones on the {@link Sheet} interface. * - * @since POI 5.2.0 + * @since 5.2.0 */ public interface OoxmlSheetExtensions { /** diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java index bbabd6ebb7..d4493192a1 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java @@ -658,7 +658,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { * * @param border - type of border to use * @see org.apache.poi.ss.usermodel.BorderStyle - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderBottom(BorderStyle border) { @@ -678,7 +678,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { * Set the type of border to use for the left border of the cell * * @param border the type of border to use - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderLeft(BorderStyle border) { @@ -698,7 +698,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { * Set the type of border to use for the right border of the cell * * @param border the type of border to use - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderRight(BorderStyle border) { @@ -718,7 +718,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { * Set the type of border to use for the top border of the cell * * @param border the type of border to use - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderTop(BorderStyle border) { @@ -832,7 +832,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { *
* @param color org.apache.poi.ss.usermodel.Color to set * @throws IllegalArgumentException if you provide a Color instance that is not a {@link XSSFColor} - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setFillBackgroundColor(org.apache.poi.ss.usermodel.Color color) { @@ -903,7 +903,7 @@ public class XSSFCellStyle implements CellStyle, Duplicatable { *
* @param color the color to use * @throws IllegalArgumentException if you provide a Color instance that is not a {@link XSSFColor} - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setFillForegroundColor(org.apache.poi.ss.usermodel.Color color) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChart.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChart.java index 0ca01fee96..fe184f8009 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChart.java @@ -68,7 +68,7 @@ public final class XSSFChart extends XDDFChart { * be * {@code application/vnd.openxmlformats-officedocument.drawingml.chart+xml} * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFChart(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChartSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChartSheet.java index 798cd4df7b..4d4ab464b8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChartSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFChartSheet.java @@ -48,7 +48,7 @@ public class XSSFChartSheet extends XSSFSheet { protected CTChartsheet chartsheet; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFChartSheet(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java index 02299a2b31..893e3ec3cd 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java @@ -371,7 +371,7 @@ public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor { /** * @return absolute top-left position, or null if position is determined from the "from" cell - * @since POI 3.17 beta 1 + * @since 3.17 beta 1 */ public CTPoint2D getPosition() { return position; @@ -379,7 +379,7 @@ public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor { /** * Sets the top-left absolute position of the object. To use this, "from" must be set to null. - * @since POI 3.17 beta 1 + * @since 3.17 beta 1 */ public void setPosition(CTPoint2D position) { this.position = position; @@ -388,7 +388,7 @@ public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor { /** * * @return size or null, if size is determined from the to and from cells - * @since POI 3.17 beta 1 + * @since 3.17 beta 1 */ public CTPositiveSize2D getSize() { return size; @@ -396,7 +396,7 @@ public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor { /** * Sets the size of the object. To use this, "to" must be set to null. - * @since POI 3.17 beta 1 + * @since 3.17 beta 1 */ public void setSize(CTPositiveSize2D size) { this.size = size; @@ -405,7 +405,7 @@ public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor { /** * Sets the anchor type * @param anchorType the anchor type to set - * @since POI 3.14 + * @since 3.14 */ @Override public void setAnchorType( AnchorType anchorType ) diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFColor.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFColor.java index 849235a11d..5b45b136f7 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFColor.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFColor.java @@ -43,7 +43,7 @@ public class XSSFColor extends ExtendedColor { /** * @param color The ooxml color object to use * @return null if color is null, new instance otherwise - * @since POI 5.2.0 + * @since 5.2.0 */ public static XSSFColor from(CTColor color) { return color == null ? null : new XSSFColor(color, null); @@ -55,7 +55,7 @@ public class XSSFColor extends ExtendedColor { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public XSSFColor() { this(CTColor.Factory.newInstance(), null); @@ -92,7 +92,7 @@ public class XSSFColor extends ExtendedColor { /** * @param rgb The RGB-byte-values for the Color - * @since POI 5.2.0 + * @since 5.2.0 */ public XSSFColor(byte[] rgb) { this(rgb, null); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFComment.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFComment.java index b0fb430712..2c573892df 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFComment.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFComment.java @@ -56,7 +56,7 @@ public class XSSFComment implements Comment { /** * Creates a new XSSFComment, associated with a given * low level comment object. - * @since POI 5.2.0 + * @since 5.2.0 */ public XSSFComment(Comments comments, CTComment comment, CTShape vmlShape) { _comment = comment; @@ -258,7 +258,7 @@ public class XSSFComment implements Comment { /** * @return the xml bean holding this comment's properties - * @since POI 5.2.0 (was protected before POI 5.2.0) + * @since 5.2.0 (was protected before POI 5.2.0) */ public CTComment getCTComment(){ return _comment; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.java index 4f8021b973..a4a1a6e380 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFConditionalFormattingThreshold.java @@ -84,7 +84,7 @@ public class XSSFConditionalFormattingThreshold implements org.apache.poi.ss.use /** * @return true if 'gte' attribute is set to true (defaults to true) - * @since POI 5.2.3 + * @since 5.2.3 */ public boolean isGte() { return cfvo.getGte(); @@ -92,7 +92,7 @@ public class XSSFConditionalFormattingThreshold implements org.apache.poi.ss.use /** * @param gte set 'gte' attribute (defaults to true) - * @since POI 5.2.3 + * @since 5.2.3 */ public void setGte(boolean gte) { cfvo.setGte(gte); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java index 12f3fc711a..90007843fd 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java @@ -106,7 +106,7 @@ public final class XSSFDrawing extends POIXMLDocumentPart implements Drawingapplication/vnd.openxmlformats-officedocument.drawing+xml * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSSFDrawing(PackagePart part) throws IOException, XmlException { super(part); @@ -710,7 +710,7 @@ public final class XSSFDrawing extends POIXMLDocumentPart implements Drawing spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java index 53b9276751..1fbab0b7be 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java @@ -45,7 +45,7 @@ final class XSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#getlastRowNum() - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public int getLastRowNum() { @@ -54,7 +54,7 @@ final class XSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#isRowHidden(int) - * @since POI 4.1.0 + * @since 4.1.0 */ @Override public boolean isRowHidden(int rowIndex) { @@ -64,7 +64,7 @@ final class XSSFEvaluationSheet implements EvaluationSheet { } /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java index 3f80c18e81..b78bf1f74d 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java @@ -46,7 +46,7 @@ public final class XSSFEvaluationWorkbook extends BaseXSSFEvaluationWorkbook { } /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFFactory.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFFactory.java index b931154d9a..6d6ebbd35b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFFactory.java @@ -33,7 +33,7 @@ public class XSSFFactory extends POIXMLFactory { protected XSSFFactory() {} /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Override protected POIXMLRelation getDescriptor(String relationshipType) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java index bbfe5443e7..6178edb9b0 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java @@ -421,7 +421,7 @@ public class XSSFHyperlink implements Hyperlink, Duplicatable { /** * @return a new XSSFHyperlink based on this - * @since POI 5.1.0 + * @since 5.1.0 */ @Override public Duplicatable copy() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java index 3683f033ae..bf9823920a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java @@ -85,7 +85,7 @@ public class XSSFPictureData extends POIXMLDocumentPart implements PictureData { * * @param part the package part holding the drawing data, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFPictureData(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCache.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCache.java index 81984550c0..8c8b86d094 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCache.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCache.java @@ -50,7 +50,7 @@ public class XSSFPivotCache extends POIXMLDocumentPart { * * @param part - The package part that holds xml data representing this pivot cache definition. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Beta protected XSSFPivotCache(PackagePart part) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheDefinition.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheDefinition.java index f1dfd1a5c9..c26ee20571 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheDefinition.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheDefinition.java @@ -60,7 +60,7 @@ public class XSSFPivotCacheDefinition extends POIXMLDocumentPart{ * * @param part - The package part that holds xml data representing this pivot cache definition. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Beta protected XSSFPivotCacheDefinition(PackagePart part) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheRecords.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheRecords.java index ddbe83e2f1..3d0472656b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheRecords.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotCacheRecords.java @@ -47,7 +47,7 @@ public class XSSFPivotCacheRecords extends POIXMLDocumentPart { * * @param part - The package part that holds xml data representing this pivot cache records. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Beta protected XSSFPivotCacheRecords(PackagePart part) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotTable.java index e96084e97a..e94b58a20a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPivotTable.java @@ -70,7 +70,7 @@ public class XSSFPivotTable extends POIXMLDocumentPart { * * @param part - The package part that holds xml data representing this pivot table. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Beta protected XSSFPivotTable(PackagePart part) throws IOException { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFRow.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFRow.java index 0c1b6db499..83d421aa5a 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFRow.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFRow.java @@ -125,7 +125,7 @@ public class XSSFRow implements Row, Comparable { * * @return a spliterator over cells in this row. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java index b9c92ddd7a..228d74c696 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java @@ -232,7 +232,7 @@ public final class XSSFShapeGroup extends XSSFShape implements ShapeContainer spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java index 59cf488993..e53f69c4b3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java @@ -123,7 +123,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * * @param part - The package part that holds xml data representing this sheet. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFSheet(PackagePart part) { super(part); @@ -796,7 +796,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * @param leftmostColumn Left column visible in right pane. * @param activePane Active pane. * @see PaneType - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, PaneType activePane) { @@ -875,7 +875,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * * @param addr The address of the cell containing the hyperlink * @return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public XSSFHyperlink getHyperlink(CellAddress addr) { @@ -1259,7 +1259,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * * @param margin which margin to get * @return the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public double getMargin(PageMargin margin) { @@ -1315,7 +1315,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * * @param margin which margin to set * @param size the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setMargin(PageMargin margin, double size) { @@ -2171,7 +2171,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * be the third row if say for instance the second row is undefined. * Call getRowNum() on each row if you care which one it is. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") @@ -2959,7 +2959,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * @param policy is the cell copy policy, which can be used to merge the source and destination * when the source is blank, copy styles only, paste as value, etc * @param context the context - see {@link CellCopyContext} - * @since POI 5.4.1 + * @since 5.4.1 */ @Beta public void copyRows(List srcRows, int destStartRow, @@ -3070,7 +3070,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * @param destStartRow the index of the first row to copy the cells to in this sheet * @param cellCopyPolicy the policy to use to determine how cells are copied * @param context the context - see {@link CellCopyContext} - * @since POI 5.4.1 + * @since 5.4.1 */ @Beta public void copyRows(int srcStartRow, int srcEndRow, int destStartRow, @@ -3614,7 +3614,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx * {@link XSSFCell#removeHyperlink()} can be used if the hyperlink is just for that one cell. * * @param hyperlink the link to remove - * @since POI 5.1.0 + * @since 5.1.0 */ public void removeHyperlink(XSSFHyperlink hyperlink) { hyperlinks.remove(hyperlink); @@ -4220,7 +4220,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx /** * Reads the dimensions of the sheet data * @return dimensions of the sheet data as a Cell Range (can be null) - * @since POI 5.2.3 + * @since 5.2.3 */ public CellRangeAddress getDimension() { if (dimensionOverride != null) { @@ -5040,7 +5040,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx /** * Currently, this is for internal use. Overrides the default dimensions of the sheet. * @param dimension {@link CellRangeAddress}, null removes the existing override - * @since POI 5.2.3 + * @since 5.2.3 */ @Beta public void setDimensionOverride(CellRangeAddress dimension) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java index a95d3659a3..5e0c9de8fa 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java @@ -169,7 +169,7 @@ public class XSSFSimpleShape extends XSSFShape implements Iterable spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTable.java index 7a4f5c78bb..15cd3bbaf8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTable.java @@ -81,7 +81,7 @@ public class XSSFTable extends POIXMLDocumentPart implements Table { /** * @param part The part used to initialize the table * @throws IOException If reading data from the part fails. - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XSSFTable(PackagePart part) throws IOException { super(part); @@ -624,7 +624,7 @@ public class XSSFTable extends POIXMLDocumentPart implements Table { } /** - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ private void setCellReferences() { String ref = ctTable.getRef(); @@ -646,7 +646,7 @@ public class XSSFTable extends POIXMLDocumentPart implements Table { * cell references with the underlying {@code CTTable}. * Thus this method is inexpensive. * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public void updateReferences() { startCellReference = null; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextParagraph.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextParagraph.java index 7f81c7dc77..c994038aeb 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextParagraph.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextParagraph.java @@ -269,7 +269,7 @@ public class XSSFTextParagraph implements Iterable{ * * @return the color of bullet characters within a given paragraph. * A null value means to use the text font color. - * @since POI 5.5.0 + * @since 5.5.0 */ public byte[] getBulletFontColorAsBytes() { ParagraphPropertyFetcher fetcher = new ParagraphPropertyFetcher(getLevel()) { @@ -301,7 +301,7 @@ public class XSSFTextParagraph implements Iterable{ * Set the color to be used on bullet characters within a given paragraph. * * @param colorArray the bullet color (as byte array) - * @since POI 5.5.0 + * @since 5.5.0 */ public void setBulletFontColor(byte[] colorArray) { CTTextParagraphProperties pr = _p.isSetPPr() ? _p.getPPr() : _p.addNewPPr(); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextRun.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextRun.java index 58142dcbf3..7880c901f3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextRun.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFTextRun.java @@ -63,7 +63,7 @@ public class XSSFTextRun { /** * @param rgb The RGB color value to set for the font - * @since POI 5.5.0 + * @since 5.5.0 */ public void setFontColor(byte[] rgb) { CTTextCharacterProperties rPr = getRPr(); @@ -89,7 +89,7 @@ public class XSSFTextRun { /** * @return the font color as a byte array. - * @since POI 5.5.0 + * @since 5.5.0 */ public byte[] getFontColorAsBytes() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVBAPart.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVBAPart.java index 8aeb3a689b..f23a8cd4c4 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVBAPart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVBAPart.java @@ -34,7 +34,7 @@ public class XSSFVBAPart extends POIXMLDocumentPart { * * @param part the package part holding the VBA data, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFVBAPart(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java index 475fcc7cc9..4753248266 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java @@ -116,7 +116,7 @@ public final class XSSFVMLDrawing extends POIXMLDocumentPart { * @param part the package part holding the drawing data, * the content type must be application/vnd.openxmlformats-officedocument.drawing+xml * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ protected XSSFVMLDrawing(PackagePart part) throws IOException, XmlException { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java index b1c63c6a98..6effa4f501 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java @@ -312,7 +312,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su * @throws POIXMLException a RuntimeException that can be caused by invalid OOXML data * @throws IllegalStateException a number of other runtime exceptions can be thrown, especially if there are problems with the * input format - * @since POI 5.2.5 + * @since 5.2.5 */ public XSSFWorkbook(InputStream stream, boolean closeStream) throws IOException { this(PackageHelper.open(stream, closeStream)); @@ -368,7 +368,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su * @throws POIXMLException a RuntimeException that can be caused by invalid OOXML data * @throws IllegalStateException a number of other runtime exceptions can be thrown, especially if there are problems with the * input format - * @since POI 4.0.0 + * @since 4.0.0 */ public XSSFWorkbook(PackagePart part) throws IOException { this(part.getInputStream(), true); @@ -376,7 +376,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su /** * @return the XSSFFactory - * @since POI 5.1.0 + * @since 5.1.0 */ public XSSFFactory getXssfFactory() { return xssfFactory; @@ -1323,7 +1323,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su * * @return a spliterator of the sheets. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") @@ -2101,7 +2101,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su * Adds an External Links Table to the workbook. * * @param externalLinksTable the External Links Table to add - * @since POI 5.5.0 + * @since 5.5.0 */ @Internal public void addExternalLinksTable(ExternalLinksTable externalLinksTable) { @@ -2114,7 +2114,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su /** * @param index the index at which to add the External Links Table * @return externalLinksTable the External Links Table to add - * @since POI 5.5.0 + * @since 5.5.0 */ @Internal public ExternalLinksTable getExternalLinksTable(int index) { @@ -2151,7 +2151,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Su * @param name The name the workbook will be referenced as in formulas * @param workbook The open workbook to fetch the link required information from * @return index position for external workbook - * @since POI 5.1.0 + * @since 5.1.0 */ @Beta @Override diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFColumnShifter.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFColumnShifter.java index 55c04a1700..86711a56bc 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFColumnShifter.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFColumnShifter.java @@ -25,7 +25,7 @@ import org.apache.poi.xssf.usermodel.XSSFSheet; /** * Helper for shifting columns up or down * - * @since POI 4.0.0 + * @since 4.0.0 */ // non-Javadoc: When possible, code should be implemented in the ColumnShifter abstract class to avoid duplication with // {@link org.apache.poi.hssf.usermodel.helpers.HSSFColumnShifter} diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFRowColShifter.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFRowColShifter.java index df55c51673..9b5744336f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFRowColShifter.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/helpers/XSSFRowColShifter.java @@ -40,7 +40,7 @@ import static org.apache.logging.log4j.util.Unbox.box; /** * Class for code common to {@link XSSFRowShifter} and {@link XSSFColumnShifter} * - * @since POI 4.0.0 + * @since 4.0.0 */ @Internal /*private*/ final class XSSFRowColShifter { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFParser.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFParser.java index e4b8c00e81..3b42a4102f 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFParser.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFParser.java @@ -32,7 +32,7 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument; * throw {@link XWPFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class XWPFParser { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFReadException.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFReadException.java index 3379b16999..e354fdb196 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFReadException.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/XWPFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class XWPFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/Document.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/Document.java index 5c117e1eb5..e00c19c588 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/Document.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/Document.java @@ -78,7 +78,7 @@ public interface Document { /** * SVG graphics (.svg) * - * @since POI 5.3.0 + * @since 5.3.0 */ public static final int PICTURE_TYPE_SVG = PictureType.SVG.ooxmlId; } diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFAbstractFootnoteEndnote.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFAbstractFootnoteEndnote.java index 443aa598b9..a4fa553b33 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFAbstractFootnoteEndnote.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFAbstractFootnoteEndnote.java @@ -118,7 +118,7 @@ public abstract class XWPFAbstractFootnoteEndnote implements Iterable spliterator() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFChart.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFChart.java index 4eca490526..6507077771 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFChart.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFChart.java @@ -58,7 +58,7 @@ public class XWPFChart extends XDDFChart { * constructor to * Create a new chart in document * - * @since POI 4.0.0 + * @since 4.0.0 */ protected XWPFChart() { super(); @@ -69,7 +69,7 @@ public class XWPFChart extends XDDFChart { * * @param part the package part holding the chart data, * the content type must be {@code application/vnd.openxmlformats-officedocument.drawingml.chart+xml} - * @since POI 4.0.0 + * @since 4.0.0 */ protected XWPFChart(PackagePart part) throws IOException, XmlException { super(part); @@ -116,7 +116,7 @@ public class XWPFChart extends XDDFChart { * * @param chartRelId the relation id of this chart in its parent document. * @param run the text run to which this chart will be inlined. - * @since POI 4.0.0 + * @since 4.0.0 */ protected void attach(String chartRelId, XWPFRun run) throws InvalidFormatException, IOException { @@ -129,7 +129,7 @@ public class XWPFChart extends XDDFChart { * set chart height * * @param height height of chart - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartHeight(long height) { ctInline.getExtent().setCy(height); @@ -139,7 +139,7 @@ public class XWPFChart extends XDDFChart { * set chart width * * @param width width of chart - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartWidth(long width) { ctInline.getExtent().setCx(width); @@ -148,7 +148,7 @@ public class XWPFChart extends XDDFChart { /** * get chart height * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartHeight() { return ctInline.getExtent().getCy(); @@ -157,7 +157,7 @@ public class XWPFChart extends XDDFChart { /** * get chart width * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartWidth() { return ctInline.getExtent().getCx(); @@ -168,7 +168,7 @@ public class XWPFChart extends XDDFChart { * * @param width width of chart * @param height height of chart - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartBoundingBox(long width, long height) { this.setChartWidth(width); @@ -179,7 +179,7 @@ public class XWPFChart extends XDDFChart { * set margin from top * * @param margin margin from top - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartTopMargin(long margin) { ctInline.setDistT(margin); @@ -188,7 +188,7 @@ public class XWPFChart extends XDDFChart { /** * get margin from Top * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartTopMargin(long margin) { return ctInline.getDistT(); @@ -198,7 +198,7 @@ public class XWPFChart extends XDDFChart { * set margin from bottom * * @param margin margin from Bottom - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartBottomMargin(long margin) { ctInline.setDistB(margin); @@ -207,7 +207,7 @@ public class XWPFChart extends XDDFChart { /** * get margin from Bottom * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartBottomMargin(long margin) { return ctInline.getDistB(); @@ -217,7 +217,7 @@ public class XWPFChart extends XDDFChart { * set margin from left * * @param margin margin from left - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartLeftMargin(long margin) { ctInline.setDistL(margin); @@ -226,7 +226,7 @@ public class XWPFChart extends XDDFChart { /** * get margin from left * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartLeftMargin(long margin) { return ctInline.getDistL(); @@ -236,7 +236,7 @@ public class XWPFChart extends XDDFChart { * set margin from Right * * @param margin from right - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartRightMargin(long margin) { ctInline.setDistR(margin); @@ -245,7 +245,7 @@ public class XWPFChart extends XDDFChart { /** * get margin from Right * - * @since POI 4.0.0 + * @since 4.0.0 */ public long getChartRightMargin(long margin) { return ctInline.getDistR(); @@ -258,7 +258,7 @@ public class XWPFChart extends XDDFChart { * @param right margin from right * @param bottom margin from bottom * @param left margin from left - * @since POI 4.0.0 + * @since 4.0.0 */ public void setChartMargin(long top, long right, long bottom, long left) { this.setChartBottomMargin(bottom); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java index 5cbba917eb..6ab26a8c31 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java @@ -127,7 +127,7 @@ public class XWPFComments extends POIXMLDocumentPart { * obtained from {@link #getAllPictures()} . * @throws InvalidFormatException If the pictureType of the picture is not known. * @throws IOException If reading the picture-data from the stream fails. - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(InputStream is, PictureType pictureType) throws InvalidFormatException, IOException { byte[] data = IOUtils.toByteArrayWithMaxLength(is, XWPFPictureData.getMaxImageSize()); @@ -158,7 +158,7 @@ public class XWPFComments extends POIXMLDocumentPart { * @return the index to this picture (0 based), the added picture can be * obtained from {@link #getAllPictures()} . * @throws InvalidFormatException If the pictureType of the picture is not known. - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(byte[] pictureData, PictureType pictureType) throws InvalidFormatException { if (pictureType == null) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultParagraphStyle.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultParagraphStyle.java index 61004d420b..adc7150dc1 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultParagraphStyle.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultParagraphStyle.java @@ -35,7 +35,7 @@ public class XWPFDefaultParagraphStyle { /** * Return the underlying XML bean. * @return underlying CTPPrGeneral bean. - * @since POI 5.5.0 + * @since 5.5.0 */ public CTPPrGeneral getPPr() { return ppr; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultRunStyle.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultRunStyle.java index 1bc06147e9..dd5e942c13 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultRunStyle.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDefaultRunStyle.java @@ -38,7 +38,7 @@ public class XWPFDefaultRunStyle { /** * Return the underlying XML bean. * @return underlying CTRPr bean. - * @since POI 5.5.0 + * @since 5.5.0 */ public CTRPr getRPr() { return rpr; @@ -48,7 +48,7 @@ public class XWPFDefaultRunStyle { * Specifies the font size. * * @return value representing the font size (can be null if size is not set) - * @since POI 5.0.0 + * @since 5.0.0 */ public Double getFontSizeAsDouble() { BigDecimal bd = getFontSizeAsBigDecimal(1); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java index 56db1b0420..ce26befae7 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java @@ -159,7 +159,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @throws POIXMLException a RuntimeException that can be caused by invalid OOXML data * @throws IllegalStateException a number of other runtime exceptions can be thrown, especially if there are problems with the * input format - * @since POI 5.2.5 + * @since 5.2.5 */ public XWPFDocument(InputStream stream, boolean closeStream) throws IOException { super(PackageHelper.open(stream, closeStream)); @@ -379,7 +379,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { /** * returns a Spliterator with paragraphs and tables * - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator getBodyElementsSpliterator() { return bodyElements.spliterator(); @@ -484,7 +484,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { /** * @return Theme document (can be null) - * @since POI 5.2.4 + * @since 5.2.4 */ public XWPFTheme getTheme() { return theme; @@ -1054,7 +1054,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * Creates an empty styles for the document if one does not already exist * * @return styles - * @since POI 5.2.4 + * @since 5.2.4 */ public XWPFTheme createTheme() { if (theme == null) { @@ -1585,7 +1585,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { /** * @return document level settings - * @since POI 5.2.1 + * @since 5.2.1 */ public XWPFSettings getSettings() { return settings; @@ -1640,7 +1640,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @return the index to this picture (0 based), the added picture can be * obtained from {@link #getAllPictures()} . * @throws InvalidFormatException if the format is not known - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(byte[] pictureData, PictureType pictureType) throws InvalidFormatException { if (pictureType == null) { @@ -1707,7 +1707,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @return the index to this picture (0 based), the added picture can be * obtained from {@link #getAllPictures()} . * @throws InvalidFormatException if the pictureType is not known - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(InputStream is, PictureType pictureType) throws InvalidFormatException { try { @@ -1739,7 +1739,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @param pictureType the {@link PictureType} * @return the next free ImageNumber * @throws InvalidFormatException If the pictureType of the picture is not known. - * @since POI 5.2.3 + * @since 5.2.3 */ public int getNextPicNameNumber(PictureType pictureType) throws InvalidFormatException { if (pictureType == null) { @@ -1817,7 +1817,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator getTablesSpliterator() { return tables.spliterator(); @@ -1828,7 +1828,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator getParagraphsSpliterator() { return paragraphs.spliterator(); @@ -1907,7 +1907,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * no need to read MS-Word file and modify charts * * @return This method return object of XWPFChart Object with default height and width - * @since POI 4.0.0 + * @since 4.0.0 */ public XWPFChart createChart() throws InvalidFormatException, IOException { return createChart(XDDFChart.DEFAULT_WIDTH, XDDFChart.DEFAULT_HEIGHT); @@ -1920,7 +1920,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @param width width of chart in document * @param height height of chart in document * @return This method return object of XWPFChart - * @since POI 4.0.0 + * @since 4.0.0 */ public XWPFChart createChart(int width, int height) throws InvalidFormatException, IOException { return createChart(createParagraph().createRun(), width, height); @@ -1932,7 +1932,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody { * @param width in EMU. * @param height in EMU. * @return the new chart. - * @since POI 4.1.2 + * @since 4.1.2 */ public XWPFChart createChart(XWPFRun run, int width, int height) throws InvalidFormatException, IOException { //get chart number diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFEndnotes.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFEndnotes.java index add139ebbe..549a746fc8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFEndnotes.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFEndnotes.java @@ -55,7 +55,7 @@ public class XWPFEndnotes extends XWPFAbstractFootnotesEndnotes { * * @param part the package part holding the data of the footnotes, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFEndnotes(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFactory.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFactory.java index fd5eca0014..378b6306ae 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFactory.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFactory.java @@ -33,7 +33,7 @@ public final class XWPFFactory extends POIXMLFactory { private XWPFFactory() {} /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ @Override protected POIXMLRelation getDescriptor(String relationshipType) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFooter.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFooter.java index 5084f39e6e..106ee0b8e8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFooter.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFooter.java @@ -67,7 +67,7 @@ public class XWPFFooter extends XWPFHeaderFooter { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFFooter(POIXMLDocumentPart parent, PackagePart part) throws IOException { super(parent, part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java index 177a570882..0d7e4c5119 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java @@ -49,7 +49,7 @@ public class XWPFFootnotes extends XWPFAbstractFootnotesEndnotes { * * @param part the package part holding the data of the footnotes, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFFootnotes(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java index 26e29902a3..2ca8f2ab6b 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java @@ -47,7 +47,7 @@ public class XWPFHeader extends XWPFHeaderFooter { } /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFHeader(POIXMLDocumentPart parent, PackagePart part) throws IOException { super(parent, part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java index 3c80d26a0a..b0ec0f4dd1 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java @@ -251,7 +251,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo * @param pictureType The {@link PictureType} of the picture. * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @throws InvalidFormatException If the format of the picture is not known. - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(byte[] pictureData, PictureType pictureType) throws InvalidFormatException { if (pictureType == null) { @@ -314,7 +314,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @throws InvalidFormatException If the format of the picture is not known. * @throws IOException If reading the picture-data from the stream fails. - * @since POI 5.2.3 + * @since 5.2.3 */ public String addPictureData(InputStream is, PictureType pictureType) throws InvalidFormatException, IOException { byte[] data = IOUtils.toByteArrayWithMaxLength(is, XWPFPictureData.getMaxImageSize()); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java index f3d6cf0f04..551a81b0a8 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java @@ -47,7 +47,7 @@ public class XWPFNumbering extends POIXMLDocumentPart { /** * create a new styles object with an existing document * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFNumbering(PackagePart part) { super(part); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java index 89a681ecf8..0fb903ab44 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java @@ -426,7 +426,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para /** * Indicates whether this paragraph should be kept on the same page as the next one. * - * @since POI 4.1.1 + * @since 4.1.1 */ public boolean isKeepNext() { if (getCTP() != null && getCTP().getPPr() != null && getCTP().getPPr().isSetKeepNext()) { @@ -438,7 +438,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para /** * Sets this paragraph to be kept on the same page as the next one or not. * - * @since POI 4.1.1 + * @since 4.1.1 */ public void setKeepNext(boolean keepNext) { CTOnOff state = CTOnOff.Factory.newInstance(); @@ -1531,7 +1531,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para * Appends a new hyperlink run to this paragraph * * @return a new hyperlink run - * @since POI 4.1.1 + * @since 4.1.1 */ public XWPFHyperlinkRun createHyperlinkRun(String uri) { // Create a relationship ID for this link. diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPicture.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPicture.java index 03deae1cd1..692977d134 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPicture.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPicture.java @@ -82,7 +82,7 @@ public class XWPFPicture { /** * Returns the width of the picture (in points). * - * @since POI 4.1.1 + * @since 4.1.1 */ public double getWidth() { return Units.toPoints(ctPic.getSpPr().getXfrm().getExt().getCx()); @@ -91,7 +91,7 @@ public class XWPFPicture { /** * Returns the depth of the picture (in points). * - * @since POI 4.1.1 + * @since 4.1.1 */ public double getDepth() { return Units.toPoints(ctPic.getSpPr().getXfrm().getExt().getCy()); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java index 7749977f01..201057e796 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java @@ -90,7 +90,7 @@ public class XWPFPictureData extends POIXMLDocumentPart { * * @param part the package part holding the drawing data, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFPictureData(PackagePart part) { super(part); @@ -175,7 +175,7 @@ public class XWPFPictureData extends POIXMLDocumentPart { * Return a {@link PictureType} that specifies type of this picture * * @return a {@link PictureType}, returns null if an unknown type - * @since POI 5.2.3 + * @since 5.2.3 */ public PictureType getPictureTypeEnum() { return PictureType.findByOoxmlId(getPictureType()); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java index 645373e042..b3507fbce4 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java @@ -281,7 +281,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * characters in the contents of this run when displayed in a document. * * @return {@code true} if the bold property for complex scripts is applied - * @since POI 5.2.5 + * @since 5.2.5 */ public boolean isComplexScriptBold() { CTRPr pr = getRunProperties(false); @@ -340,7 +340,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { *

* * @param value {@code true} if the bold property is applied for complex characters - * @since POI 5.2.5 + * @since 5.2.5 */ public void setComplexScriptBold(boolean value) { CTRPr pr = getRunProperties(true); @@ -378,7 +378,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * Returns number of text element * * @return number of text elements - * @since POI 5.4.1 + * @since 5.4.1 */ public int getNumberOfTexts() { return run.sizeOfTArray(); @@ -442,7 +442,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * characters in the contents of this run when displayed in a document. * * @return {@code true} if the italic property is applied for complex characters. - * @since POI 5.2.5 + * @since 5.2.5 */ public boolean isComplexScriptItalic() { CTRPr pr = getRunProperties(false); @@ -497,7 +497,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * applied to the complex characters. * * @param value {@code true} if the italic property is applied for complex characters. - * @since POI 5.2.5 + * @since 5.2.5 */ public void setComplexScriptItalic(boolean value) { CTRPr pr = getRunProperties(true); @@ -963,7 +963,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * characters in the contents of this run when displayed. * * @return value representing the font size (can be null if size not set) - * @since POI 5.0.0 + * @since 5.0.0 */ @Override public Double getFontSizeAsDouble() { @@ -976,7 +976,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * characters in the contents of this run when displayed. * * @return value representing the font size for the complex scripts (can be null if size not set) - * @since POI 5.2.5 + * @since 5.2.5 */ public Double getComplexScriptFontSizeAsDouble() { BigDecimal bd = getComplexScriptFontSizeAsBigDecimal(1); @@ -1031,7 +1031,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * * @param size The font size as number of point measurements. * @see #setComplexScriptFontSize(double) - * @since POI 5.2.5 + * @since 5.2.5 */ public void setComplexScriptFontSize(int size) { CTRPr pr = getRunProperties(true); @@ -1053,7 +1053,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * * @param size The font size as number of point measurements. * @see #setFontSize(int) - * @since POI 5.0.0 + * @since 5.0.0 */ @Override public void setFontSize(double size) { @@ -1077,7 +1077,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * * @param size The font size as number of point measurements. * @see #setFontSize(int) - * @since POI 5.2.5 + * @since 5.2.5 */ public void setComplexScriptFontSize(double size) { CTRPr pr = getRunProperties(true); @@ -1257,7 +1257,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units} * @throws InvalidFormatException If the format of the picture is not known. * @throws IOException If reading the picture-data from the stream fails. - * @since POI 5.2.3 + * @since 5.2.3 */ public XWPFPicture addPicture(InputStream pictureData, PictureType pictureType, String filename, int width, int height) throws InvalidFormatException, IOException { @@ -1370,7 +1370,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * this method add chart template into document * * @param chartRelId relation id of chart in document relation file - * @since POI 4.0.0 + * @since 4.0.0 */ @Internal public CTInline addChart(String chartRelId) throws InvalidFormatException, IOException { @@ -1428,7 +1428,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { * Set the style ID for the run. * * @param styleId ID (not name) of the style to set for the run, e.g. "BoldItalic" (not "Bold Italic"). - * @since POI 4.1.1 + * @since 4.1.1 */ public void setStyle(String styleId) { CTRPr pr = getCTR().getRPr(); @@ -1842,7 +1842,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun { /** * Returns the charts embedded in the run. * @return A list of the XWPFChart objects embedded in the run. - * @since POI 5.5.0 + * @since 5.5.0 */ public List getEmbeddedCharts() { return Collections.unmodifiableList(charts); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java index 132fa95e11..c2e382f818 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java @@ -45,7 +45,7 @@ public class XWPFSDTCell extends XWPFAbstractSDT implements ICell { /** * Return the underlying XML bean. * @return the underlying CTSdtCell bean. - * @since POI 5.5.0 + * @since 5.5.0 */ public CTSdtCell getCTSdtCell() { return sdtCell; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java index 3da8b87b9a..fb3c9d96e3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java @@ -124,7 +124,7 @@ public class XWPFSDTContentCell implements ISDTContent { /** * Return the underlying XML bean. * @return the underlying CTSdtContentCell bean. - * @since POI 5.5.0 + * @since 5.5.0 */ public CTSdtContentCell getCTSdtContentCell() { return sdtContentCell; diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java index 696935db16..73b5efb217 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java @@ -50,7 +50,7 @@ public class XWPFSettings extends POIXMLDocumentPart { private CTSettings ctSettings; /** - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFSettings(PackagePart part) throws IOException { super(part); @@ -71,7 +71,7 @@ public class XWPFSettings extends POIXMLDocumentPart { /** * @return ctSettings instance - * @since POI 5.2.4 + * @since 5.2.4 */ @Internal public CTSettings getCTSettings() { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java index 2cf75f302e..d878609faf 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java @@ -62,7 +62,7 @@ public class XWPFStyles extends POIXMLDocumentPart { * * @param part the package part holding the data of the styles, * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ public XWPFStyles(PackagePart part) { super(part); @@ -152,7 +152,7 @@ public class XWPFStyles extends POIXMLDocumentPart { * Gets the underlying CTStyles object for the Styles. * * @return CTStyles object - * @since POI 5.4.0 + * @since 5.4.0 */ public CTStyles getCtStyles() { return ctStyles; @@ -161,7 +161,7 @@ public class XWPFStyles extends POIXMLDocumentPart { /** * Get the list of {@link XWPFStyle} in the Styles part. * - * @since POI 5.4.0 + * @since 5.4.0 */ public List getStyles() { return Collections.unmodifiableList(listStyle); @@ -172,7 +172,7 @@ public class XWPFStyles extends POIXMLDocumentPart { * * @param pos Array position of the style to be removed * @return True if the style was removed. - * @since POI 5.4.0 + * @since 5.4.0 */ public boolean removeStyle(int pos) { if (pos >= 0 && pos < getNumberOfStyles()) { diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java index 6e590e5f9e..cbf6b5fe56 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java @@ -448,7 +448,7 @@ public class XWPFTableCell implements IBody, ICell { * This was the behaviour of {@link XWPFTableCell#setText(String)} before POI 5.2.4 * * @param text The text to append to the cells content. - * @since POI 5.2.4 + * @since 5.2.4 */ public void appendText(String text) { XWPFParagraph par = paragraphs.isEmpty() ? addParagraph() : paragraphs.get(0); diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTheme.java b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTheme.java index 0d7bca297b..735b930c88 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTheme.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTheme.java @@ -41,7 +41,7 @@ import static org.apache.poi.ooxml.POIXMLTypeLoader.DEFAULT_XML_OPTIONS; /** * A shared style sheet in a .docx document * - * @since POI 5.2.4 + * @since 5.2.4 */ public class XWPFTheme extends POIXMLDocumentPart { private CTOfficeStyleSheet _theme; diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFParser.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFParser.java index b6e35df4f3..b5b7ccea6c 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFParser.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFParser.java @@ -28,7 +28,7 @@ import org.apache.poi.util.ExceptionUtil; * throw {@link HSLFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class HSLFParser { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFReadException.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFReadException.java index 4411401873..58193acb98 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFReadException.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/HSLFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class HSLFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/HSLFEscherClientDataRecord.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/HSLFEscherClientDataRecord.java index 9ee2d60c83..7217d8b982 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/HSLFEscherClientDataRecord.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/HSLFEscherClientDataRecord.java @@ -34,7 +34,7 @@ import org.apache.poi.util.LittleEndian; * The number, position, and type of placeholder shapes are determined by * the slide layout as specified in the SlideAtom record. * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ public class HSLFEscherClientDataRecord extends EscherClientDataRecord { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/PPDrawing.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/PPDrawing.java index ad2ef029f1..267034076a 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/PPDrawing.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/PPDrawing.java @@ -87,7 +87,7 @@ public final class PPDrawing extends RecordAtom implements Iterable spliterator() { @@ -290,7 +290,7 @@ public final class PPDrawing extends RecordAtom implements Iterable { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java index 3957b0fffb..d7b23709d8 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFPlaceholderDetails.java @@ -24,7 +24,7 @@ import org.apache.poi.sl.usermodel.PlaceholderDetails; /** * Extended placeholder details for HSLF sheets - mainly for headers and footers * - * @since POI 4.0.0 + * @since 4.0.0 */ public class HSLFPlaceholderDetails implements PlaceholderDetails { private final HSLFSheet sheet; diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShape.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShape.java index 6475a00bfd..87fa7c21fb 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShape.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShape.java @@ -239,7 +239,7 @@ public abstract class HSLFShape implements Shape { } /** - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ public static T getEscherChild(EscherContainerRecord owner, EscherRecordTypes recordId){ return getEscherChild(owner, recordId.typeID); @@ -254,7 +254,7 @@ public abstract class HSLFShape implements Shape { } /** - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ public T getEscherChild(EscherRecordTypes recordId){ return getEscherChild(recordId.typeID); diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShapePlaceholderDetails.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShapePlaceholderDetails.java index 348d901235..04dd8aefa6 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShapePlaceholderDetails.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFShapePlaceholderDetails.java @@ -44,7 +44,7 @@ import org.apache.poi.util.LocaleUtil; /** * Extended placeholder details for HSLF shapes * - * @since POI 4.0.0 + * @since 4.0.0 */ public class HSLFShapePlaceholderDetails extends HSLFPlaceholderDetails { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSheet.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSheet.java index 9ce908e8e8..4edaf94a3d 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSheet.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSheet.java @@ -365,7 +365,7 @@ public abstract class HSLFSheet implements HSLFShapeContainer, Sheet spliterator() { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java index d55e204c46..9e020cfd4b 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShow.java @@ -919,7 +919,7 @@ public final class HSLFSlideShow extends POIDocument implements SlideShow spliterator() { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFTextShape.java b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFTextShape.java index 77b7559714..1efae0f478 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFTextShape.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFTextShape.java @@ -684,7 +684,7 @@ implements TextShape { * * @return {@link RoundTripHFPlaceholder12} or {@code null} if not found * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ public RoundTripHFPlaceholder12 getHFPlaceholderAtom() { // special case for files saved in Office 2007 @@ -706,7 +706,7 @@ implements TextShape { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/AttachmentChunks.java b/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/AttachmentChunks.java index 9261804bee..831997f458 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/AttachmentChunks.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/AttachmentChunks.java @@ -150,7 +150,7 @@ public class AttachmentChunks implements ChunkGroup { /** * @return long path name for the attachment - * @since POI 5.4.0 + * @since 5.4.0 */ public StringChunk getAttachLongPathName() { return attachLongPathName; @@ -158,7 +158,7 @@ public class AttachmentChunks implements ChunkGroup { /** * @return attachment content location -- relative or absolute URI matching reference in html body - * @since POI 5.4.0 + * @since 5.4.0 */ public StringChunk getAttachContentLocation() { return attachContentLocation; @@ -166,7 +166,7 @@ public class AttachmentChunks implements ChunkGroup { /** * @return the display name of the attachment - * @since POI 5.4.0 + * @since 5.4.0 */ public StringChunk getAttachDisplayName() { return attachDisplayName; @@ -174,7 +174,7 @@ public class AttachmentChunks implements ChunkGroup { /** * @return the language property for the attachment - * @since POI 5.4.0 + * @since 5.4.0 */ public StringChunk getAttachLanguage() { return attachLanguage; @@ -210,7 +210,7 @@ public class AttachmentChunks implements ChunkGroup { /** * @return record key - * @since POI 5.4.0 + * @since 5.4.0 */ public ByteChunk getAttachRecordKey() { return attachRecordKey; diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/Types.java b/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/Types.java index 9bfc6eed3d..01744b42f2 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/Types.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hsmf/datatypes/Types.java @@ -140,7 +140,7 @@ public final class Types { /** * @return whether the type is a pointer - * @since POI 5.2.4 + * @since 5.2.4 */ public boolean isPointer() { return (length == -1) || (length > 8); diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/AbstractExcelUtils.java b/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/AbstractExcelUtils.java index 3485f40911..b92b318ae0 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/AbstractExcelUtils.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hssf/converter/AbstractExcelUtils.java @@ -35,7 +35,7 @@ import org.apache.poi.util.Internal; * Common class for {@link ExcelToFoConverter} and {@link ExcelToHtmlConverter} * * @see AbstractWordUtils - * @since POI 3.8 beta 5 + * @since 3.8 beta 5 */ @Internal class AbstractExcelUtils { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfFill.java b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfFill.java index 4dda258df2..7dfa823252 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfFill.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwmf/record/HwmfFill.java @@ -54,7 +54,7 @@ public class HwmfFill { * @param hasAlpha if true, the background color is rendered transparent - see {@link HwmfMisc.WmfSetBkMode.HwmfBkMode} * @return the image * - * @since POI 4.1.1 + * @since 4.1.1 */ BufferedImage getImage(Color foreground, Color background, boolean hasAlpha); @@ -62,7 +62,7 @@ public class HwmfFill { * @return the raw BMP data * * @see BMP format - * @since POI 4.1.1 + * @since 4.1.1 */ byte[] getBMPData(); } diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFParser.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFParser.java index 0799748481..e8f049aeb6 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFParser.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFParser.java @@ -27,7 +27,7 @@ import org.apache.poi.util.ExceptionUtil; * throw {@link HWPFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class HWPFParser { diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFReadException.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFReadException.java index f740d45b63..78efe7aebd 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFReadException.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/HWPFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class HWPFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/HWPFList.java b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/HWPFList.java index 11a14b858c..28cbba7717 100644 --- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/HWPFList.java +++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/usermodel/HWPFList.java @@ -181,7 +181,7 @@ public final class HWPFList } /** - * @since POI 5.2.4 + * @since 5.2.4 */ public boolean isStartAtOverridden(char level ) { diff --git a/poi/src/main/java/org/apache/poi/POIDocument.java b/poi/src/main/java/org/apache/poi/POIDocument.java index 746e9d4ffc..0f4239bb82 100644 --- a/poi/src/main/java/org/apache/poi/POIDocument.java +++ b/poi/src/main/java/org/apache/poi/POIDocument.java @@ -381,7 +381,7 @@ public abstract class POIDocument implements Closeable { * you must use {@link #write(OutputStream)} or {@link #write(File)} to * write to a brand new document. * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 * * @throws IOException thrown on errors writing to the file * @throws IllegalStateException if this isn't from a writable File @@ -392,7 +392,7 @@ public abstract class POIDocument implements Closeable { * Writes the document out to the specified new {@link File}. If the file * exists, it will be replaced, otherwise a new one will be created * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 * * @param newFile The new File to write to. * diff --git a/poi/src/main/java/org/apache/poi/POIException.java b/poi/src/main/java/org/apache/poi/POIException.java index ef656b6598..fc6fd161f2 100644 --- a/poi/src/main/java/org/apache/poi/POIException.java +++ b/poi/src/main/java/org/apache/poi/POIException.java @@ -24,7 +24,7 @@ package org.apache.poi; * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature. * - * @since POI 5.5.0 + * @since 5.5.0 */ public class POIException extends Exception { private static final long serialVersionUID = 1L; diff --git a/poi/src/main/java/org/apache/poi/POIReadOnlyDocument.java b/poi/src/main/java/org/apache/poi/POIReadOnlyDocument.java index 5f250704db..641edec5af 100644 --- a/poi/src/main/java/org/apache/poi/POIReadOnlyDocument.java +++ b/poi/src/main/java/org/apache/poi/POIReadOnlyDocument.java @@ -27,7 +27,7 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem; * This holds the common functionality for all read-only * POI Document classes, i.e. ones which don't support writing. * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public abstract class POIReadOnlyDocument extends POIDocument { protected POIReadOnlyDocument(DirectoryNode dir) { diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/HyperlinkType.java b/poi/src/main/java/org/apache/poi/common/usermodel/HyperlinkType.java index d38fa16c88..82cfa5abb5 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/HyperlinkType.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/HyperlinkType.java @@ -19,7 +19,7 @@ package org.apache.poi.common.usermodel; import org.apache.poi.util.Internal; /** - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public enum HyperlinkType { /** Not a hyperlink */ diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/PictureType.java b/poi/src/main/java/org/apache/poi/common/usermodel/PictureType.java index 40427c05b0..58f3c0a00e 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/PictureType.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/PictureType.java @@ -24,7 +24,7 @@ import java.util.HashMap; /** * General enum class to define a picture format/type * - * @since POI 5.0 + * @since 5.0.0 */ public enum PictureType { diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontCharset.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontCharset.java index a828c1cc03..5fcb23e2c6 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontCharset.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontCharset.java @@ -27,7 +27,7 @@ import org.apache.poi.logging.PoiLogManager; * Charset represents the basic set of characters associated with a font (that it can display), and * corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ @SuppressWarnings("java:S1192") public enum FontCharset { diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFacet.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFacet.java index 0489b58ff4..253d0a11ce 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFacet.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFacet.java @@ -35,7 +35,7 @@ public interface FontFacet { * * @return the font weight * - * @since POI 4.1.0 + * @since 4.1.0 */ default int getWeight() { return FontHeader.REGULAR_WEIGHT; diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFamily.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFamily.java index b627e10af8..c38c5a4044 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFamily.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontFamily.java @@ -20,7 +20,7 @@ package org.apache.poi.common.usermodel.fonts; /** * A property of a font that describes its general appearance. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ public enum FontFamily { /** diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontGroup.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontGroup.java index cdbaefe90f..f3baf20c49 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontGroup.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontGroup.java @@ -27,7 +27,7 @@ import java.util.TreeMap; * Text runs can contain characters which will be handled (if configured) by a different font, * because the default font (latin) doesn't contain corresponding glyphs. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 * * @see Office Open XML Themes, Schemes, and Fonts */ diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontInfo.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontInfo.java index a60001acce..80970110c3 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontInfo.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontInfo.java @@ -31,7 +31,7 @@ import org.apache.poi.util.Beta; * * Setting an unsupported property results in an {@link UnsupportedOperationException}. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 * * @see LOGFONT structure */ diff --git a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontPitch.java b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontPitch.java index 5d1d48e63e..da251d94b8 100644 --- a/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontPitch.java +++ b/poi/src/main/java/org/apache/poi/common/usermodel/fonts/FontPitch.java @@ -20,7 +20,7 @@ package org.apache.poi.common.usermodel.fonts; /** * A property of a font that describes the pitch, of the characters. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ public enum FontPitch { /** diff --git a/poi/src/main/java/org/apache/poi/ddf/EscherArrayProperty.java b/poi/src/main/java/org/apache/poi/ddf/EscherArrayProperty.java index d40cbabe35..233fa0a8bc 100644 --- a/poi/src/main/java/org/apache/poi/ddf/EscherArrayProperty.java +++ b/poi/src/main/java/org/apache/poi/ddf/EscherArrayProperty.java @@ -246,7 +246,7 @@ public final class EscherArrayProperty extends EscherComplexProperty implements } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/ddf/EscherContainerRecord.java b/poi/src/main/java/org/apache/poi/ddf/EscherContainerRecord.java index e343bd86b5..a5456159be 100644 --- a/poi/src/main/java/org/apache/poi/ddf/EscherContainerRecord.java +++ b/poi/src/main/java/org/apache/poi/ddf/EscherContainerRecord.java @@ -193,7 +193,7 @@ public final class EscherContainerRecord extends EscherRecord implements Iterabl /** * @return a spliterator over the child records * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java index 68a02c82cc..2b8ca5a450 100644 --- a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java +++ b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java @@ -147,7 +147,7 @@ public final class ExtractorFactory { * Clears the setting for this thread made by {@link #setThreadPrefersEventExtractors(boolean) } * * @see #setThreadPrefersEventExtractors(boolean) - * @since POI 5.2.4 + * @since 5.2.4 */ public static void removeThreadPrefersEventExtractorsSetting() { threadPreferEventExtractors.remove(); diff --git a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java index 688fd6fa0c..42c7e1e86d 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java +++ b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java @@ -275,7 +275,7 @@ public class ClassID implements Duplicatable, GenericRecord { * Converts the ClassID to an UUID * @return the ClassID as UUID * - * @since POI 5.0.0 + * @since 5.0.0 */ public UUID toUUID() { final long mostSigBits = ByteBuffer.wrap(bytes, 0, 8).getLong(); diff --git a/poi/src/main/java/org/apache/poi/hssf/HSSFParser.java b/poi/src/main/java/org/apache/poi/hssf/HSSFParser.java index 14bdeecfd6..11bf9c83b7 100644 --- a/poi/src/main/java/org/apache/poi/hssf/HSSFParser.java +++ b/poi/src/main/java/org/apache/poi/hssf/HSSFParser.java @@ -28,7 +28,7 @@ import org.apache.poi.util.ExceptionUtil; * throw {@link HSSFReadException} or {@link IOException} instead of {@link RuntimeException}. * You can still get an {@link Error}s like an {@link OutOfMemoryError}. * - * @since POI 5.5.0 + * @since 5.5.0 */ public final class HSSFParser { diff --git a/poi/src/main/java/org/apache/poi/hssf/HSSFReadException.java b/poi/src/main/java/org/apache/poi/hssf/HSSFReadException.java index 4f77a6a720..088c5a07b9 100644 --- a/poi/src/main/java/org/apache/poi/hssf/HSSFReadException.java +++ b/poi/src/main/java/org/apache/poi/hssf/HSSFReadException.java @@ -26,7 +26,7 @@ import org.apache.poi.POIException; * exceptions, but this is not a good practice. This class is a checked * class that extends {@link Exception} so needs to be explicitly * caught or declared in the method signature.

- * @since POI 5.5.0 + * @since 5.5.0 */ public class HSSFReadException extends POIException { private static final long serialVersionUID = 1L; diff --git a/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java b/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java index 4d0c28f894..0f4853bcf8 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java @@ -123,7 +123,7 @@ public final class FormulaRecord extends CellRecord { /** * @return The type of the cached value or CellType.NUMERIC.getCode() if the cached value is empty * - * @since POI 6.0.0 + * @since 6.0.0 */ public CellType getCachedResultType() { if (specialCachedValue == null) { diff --git a/poi/src/main/java/org/apache/poi/hssf/record/FormulaSpecialCachedValue.java b/poi/src/main/java/org/apache/poi/hssf/record/FormulaSpecialCachedValue.java index fe4cd5a48a..4da28f8ba1 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/FormulaSpecialCachedValue.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/FormulaSpecialCachedValue.java @@ -165,7 +165,7 @@ public final class FormulaSpecialCachedValue implements GenericRecord { /** * Returns the type of the cached value * @return A CellType - * @since POI 5.0.0 + * @since 5.0.0 */ public CellType getValueTypeEnum() { int typeCode = getTypeCode(); diff --git a/poi/src/main/java/org/apache/poi/hssf/record/OldFormulaRecord.java b/poi/src/main/java/org/apache/poi/hssf/record/OldFormulaRecord.java index f6478d752c..021a411ee9 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/OldFormulaRecord.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/OldFormulaRecord.java @@ -68,7 +68,7 @@ public final class OldFormulaRecord extends OldCellRecord { /** * Returns the type of the cached result * @return A CellType - * @since POI 6.0.0 + * @since 6.0.0 */ public CellType getCachedResultType() { if (specialCachedValue == null) { @@ -80,7 +80,7 @@ public final class OldFormulaRecord extends OldCellRecord { /** * Returns the type of the cached result * @return A CellType - * @since POI 5.0.0 + * @since 5.0.0 * @deprecated POI 6.0.0, use {@link #getCachedResultType()} instead */ @Deprecated diff --git a/poi/src/main/java/org/apache/poi/hssf/record/PageBreakRecord.java b/poi/src/main/java/org/apache/poi/hssf/record/PageBreakRecord.java index 1df6e28c8e..0bcf2916c7 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/PageBreakRecord.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/PageBreakRecord.java @@ -148,7 +148,7 @@ public abstract class PageBreakRecord extends StandardRecord { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public final Spliterator getBreaksSpliterator() { return _breaks.spliterator(); diff --git a/poi/src/main/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java b/poi/src/main/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java index 2f6a8bd2e5..ffd22728d6 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java @@ -313,7 +313,7 @@ public final class RowRecordsAggregate extends RecordAggregate { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator getSpliterator() { return _rowRecords.values().spliterator(); @@ -476,7 +476,7 @@ public final class RowRecordsAggregate extends RecordAggregate { /** * Returns a spliterator for the cell values * - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator getCellValueSpliterator() { return _valuesAgg.spliterator(); diff --git a/poi/src/main/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java b/poi/src/main/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java index 3407d571c2..7a6a018755 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java @@ -359,7 +359,7 @@ public final class ValueRecordsAggregate implements Iterable spliterator() { diff --git a/poi/src/main/java/org/apache/poi/hssf/record/common/UnicodeString.java b/poi/src/main/java/org/apache/poi/hssf/record/common/UnicodeString.java index 08293947ba..e87c4e55a5 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/common/UnicodeString.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/common/UnicodeString.java @@ -326,7 +326,7 @@ public class UnicodeString implements Comparable, Duplicatable, G } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator formatSpliterator() { if (field_4_format_runs != null) { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCell.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCell.java index ddb3914f26..b4d5f4b62c 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCell.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCell.java @@ -1180,7 +1180,7 @@ public class HSSFCell extends CellBase { * {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending * on the cached value of the formula * - * @since POI 4.0 + * @since 4.0 */ @Override public CellType getCachedFormulaResultType() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java index d9e7eb33cd..f08f663246 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java @@ -425,7 +425,7 @@ public final class HSSFCellStyle implements CellStyle, Duplicatable { /** * set the type of border to use for the left border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderLeft(BorderStyle border) @@ -444,7 +444,7 @@ public final class HSSFCellStyle implements CellStyle, Duplicatable { /** * set the type of border to use for the right border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderRight(BorderStyle border) @@ -463,7 +463,7 @@ public final class HSSFCellStyle implements CellStyle, Duplicatable { /** * set the type of border to use for the top border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ @Override public void setBorderTop(BorderStyle border) @@ -687,7 +687,7 @@ public final class HSSFCellStyle implements CellStyle, Duplicatable { *
* @param color the color to use * @throws IllegalArgumentException if you provide a Color instance that is not a {@link HSSFColor} - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setFillBackgroundColor(org.apache.poi.ss.usermodel.Color color) @@ -747,7 +747,7 @@ public final class HSSFCellStyle implements CellStyle, Duplicatable { *
* @param color the color to use * @throws IllegalArgumentException if you provide a Color instance that is not a {@link HSSFColor} - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setFillForegroundColor(org.apache.poi.ss.usermodel.Color color) diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java index a9ffbea496..d23f632aab 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFClientAnchor.java @@ -261,7 +261,7 @@ public final class HSSFClientAnchor extends HSSFAnchor implements ClientAnchor { /** * Sets the anchor type * @param anchorType the anchor type to set - * @since POI 3.14 + * @since 3.14 */ @Override public void setAnchorType(AnchorType anchorType) { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationCell.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationCell.java index 5a393bee95..da1c109972 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationCell.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationCell.java @@ -94,7 +94,7 @@ final class HSSFEvaluationCell implements EvaluationCell { } /** - * @since POI 4.0 + * @since 4.0 * @return cell type of cached formula result */ @Override diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java index 12716407d3..41dfd0f7d6 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java @@ -39,7 +39,7 @@ final class HSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#getlastRowNum() - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public int getLastRowNum() { @@ -48,7 +48,7 @@ final class HSSFEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#isRowHidden(int) - * @since POI 4.1.0 + * @since 4.1.0 */ @Override public boolean isRowHidden(int rowIndex) { @@ -71,7 +71,7 @@ final class HSSFEvaluationSheet implements EvaluationSheet { } /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java index 6220a64d3a..5306b63520 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java @@ -61,7 +61,7 @@ public final class HSSFEvaluationWorkbook implements FormulaRenderingWorkbook, E } /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java index 57551e10ca..3ffb051135 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java @@ -264,7 +264,7 @@ public class HSSFHyperlink implements Hyperlink, Duplicatable { /** * @return a new HSSFHyperlink based on this - * @since POI 5.1.0 + * @since 5.1.0 */ @Override public Duplicatable copy() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java index dc64f10f5e..ff2485cf6b 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java @@ -572,7 +572,7 @@ public final class HSSFPatriarch implements HSSFShapeContainer, Drawing spliterator() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPicture.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPicture.java index d232c9bd2c..48269513d0 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPicture.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPicture.java @@ -149,7 +149,7 @@ public class HSSFPicture extends HSSFSimpleShape implements Picture { * Calculate the preferred size for this picture. * * @return HSSFClientAnchor with the preferred size for this image - * @since POI 3.0.2 + * @since 3.0.2 */ @Override public HSSFClientAnchor getPreferredSize(){ @@ -161,7 +161,7 @@ public class HSSFPicture extends HSSFSimpleShape implements Picture { * * @param scale the amount by which image dimensions are multiplied relative to the original size. * @return HSSFClientAnchor with the preferred size for this image - * @since POI 3.0.2 + * @since 3.0.2 */ public HSSFClientAnchor getPreferredSize(double scale){ return getPreferredSize(scale, scale); @@ -173,7 +173,7 @@ public class HSSFPicture extends HSSFSimpleShape implements Picture { * @param scaleX the amount by which image width is multiplied relative to the original width. * @param scaleY the amount by which image height is multiplied relative to the original height. * @return HSSFClientAnchor with the preferred size for this image - * @since POI 3.11 + * @since 3.11 */ @Override public HSSFClientAnchor getPreferredSize(double scaleX, double scaleY){ diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java index 1a0fca32e8..76cd1f76d1 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFShapeGroup.java @@ -417,7 +417,7 @@ public class HSSFShapeGroup extends HSSFShape implements HSSFShapeContainer { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index 9e56f37714..e66d574e50 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -971,7 +971,7 @@ public final class HSSFSheet implements Sheet { * be the third row if say for instance the second row is undefined. * Call getRowNum() on each row if you care which one it is. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") // can this clumsy generic syntax be improved? @@ -1324,7 +1324,7 @@ public final class HSSFSheet implements Sheet { * * @param margin which margin to get * @return the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public double getMargin(PageMargin margin) { @@ -1367,7 +1367,7 @@ public final class HSSFSheet implements Sheet { * * @param margin which margin to set * @param size the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void setMargin(PageMargin margin, double size) { @@ -1897,7 +1897,7 @@ public final class HSSFSheet implements Sheet { * @param leftmostColumn Left column visible in right pane. * @param activePane Active pane. * @see PaneType - * @since POI 5.2.3 + * @since 5.2.3 */ @Override public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, PaneType activePane) { @@ -2342,7 +2342,7 @@ public final class HSSFSheet implements Sheet { * * @param addr The address of the cell containing the hyperlink * @return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public HSSFHyperlink getHyperlink(CellAddress addr) { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index 0795b91c93..f80383b52c 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -987,7 +987,7 @@ public final class HSSFWorkbook extends POIDocument implements Workbook { * * @return a spliterator of the sheets. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override @SuppressWarnings("unchecked") @@ -1782,7 +1782,7 @@ public final class HSSFWorkbook extends POIDocument implements Workbook { * writing HSSFWorkbook. *

* @param cellReferenceType the type of cell references used - * @since POI 5.2.1 + * @since 5.2.1 */ @Override public void setCellReferenceType(CellReferenceType cellReferenceType) { diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFColumnShifter.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFColumnShifter.java index 1f2ce9bb6b..7b646a1868 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFColumnShifter.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFColumnShifter.java @@ -27,7 +27,7 @@ import org.apache.poi.util.NotImplemented; /** * Helper for shifting columns up or down * - * @since POI 4.0.0 + * @since 4.0.0 */ // non-Javadoc: When possible, code should be implemented in the ColumnShifter abstract class to avoid duplication with // {@link org.apache.poi.hssf.usermodel.helpers.HSSFColumnShifter} diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFRowColShifter.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFRowColShifter.java index dc68c77dcb..98611bb5d2 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFRowColShifter.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/helpers/HSSFRowColShifter.java @@ -30,7 +30,7 @@ import static org.apache.logging.log4j.util.Unbox.box; /** * Class for code common to {@link HSSFRowShifter} and {@link HSSFColumnShifter} * - * @since POI 5.1.0 + * @since 5.1.0 */ @Internal /*private*/ final class HSSFRowColShifter { diff --git a/poi/src/main/java/org/apache/poi/hssf/util/HSSFColor.java b/poi/src/main/java/org/apache/poi/hssf/util/HSSFColor.java index 1b3149da64..1d11967d4b 100644 --- a/poi/src/main/java/org/apache/poi/hssf/util/HSSFColor.java +++ b/poi/src/main/java/org/apache/poi/hssf/util/HSSFColor.java @@ -50,7 +50,7 @@ public class HSSFColor implements Color { /** * Predefined HSSFColors with their given palette index (and an optional 2nd index) * - * @since POI 3.16 beta 2 + * @since 3.16 beta 2 */ public enum HSSFColorPredefined { BLACK (0x08, -1, 0x000000), @@ -183,7 +183,7 @@ public class HSSFColor implements Color { * @param index Index to the standard color palette * @param index2 Index to the alternate color palette * @param rgb combined value of RGB - * @since POI 5.5.0 + * @since 5.5.0 */ public HSSFColor(int index, int index2, int rgb) { this.index = index; diff --git a/poi/src/main/java/org/apache/poi/logging/PoiLogManager.java b/poi/src/main/java/org/apache/poi/logging/PoiLogManager.java index 2da065311f..382655d11b 100644 --- a/poi/src/main/java/org/apache/poi/logging/PoiLogManager.java +++ b/poi/src/main/java/org/apache/poi/logging/PoiLogManager.java @@ -27,7 +27,7 @@ import org.apache.poi.util.SuppressForbidden; *

Internal use only.

*

Fails over to a No-Op logger if there are problems creating log4j logger.

* - * @since POI 5.4.0 + * @since 5.4.0 */ public final class PoiLogManager { diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java index 07945f97cd..a2048c3292 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/DirectoryNode.java @@ -574,7 +574,7 @@ public class DirectoryNode /** * Returns a Spliterator over all the entries * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java index f9410c0264..1e76c2deee 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/FilteringDirectoryNode.java @@ -118,7 +118,7 @@ public class FilteringDirectoryNode implements DirectoryEntry } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java b/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java index 910afb4b79..2aef6d819f 100644 --- a/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java +++ b/poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java @@ -237,7 +237,7 @@ public class POIFSFileSystem extends BlockStore * {@link #close()} is called, or when this constructor throws * an exception * @throws IOException on errors reading, or on invalid data - * @since POI 5.1.0 + * @since 5.1.0 */ public POIFSFileSystem(FileChannel channel, boolean readOnly, boolean closeChannel) throws IOException { diff --git a/poi/src/main/java/org/apache/poi/poifs/nio/FileBackedDataSource.java b/poi/src/main/java/org/apache/poi/poifs/nio/FileBackedDataSource.java index 52ff3a2381..b5c3050c29 100644 --- a/poi/src/main/java/org/apache/poi/poifs/nio/FileBackedDataSource.java +++ b/poi/src/main/java/org/apache/poi/poifs/nio/FileBackedDataSource.java @@ -70,7 +70,7 @@ public class FileBackedDataSource extends DataSource implements Closeable { } /** - * @since POI 5.1.0 + * @since 5.1.0 */ public FileBackedDataSource(FileChannel channel, boolean readOnly, boolean closeChannelOnClose) { this(null, channel, readOnly, closeChannelOnClose); diff --git a/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java b/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java index bfa8796634..d2511652a5 100644 --- a/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java +++ b/poi/src/main/java/org/apache/poi/poifs/property/DirectoryProperty.java @@ -250,7 +250,7 @@ public class DirectoryProperty extends Property implements Parent, Iterable spliterator() { diff --git a/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java b/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java index 766958ab20..7eec5ad903 100644 --- a/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java +++ b/poi/src/main/java/org/apache/poi/poifs/storage/BATBlock.java @@ -199,7 +199,7 @@ public final class BATBlock implements BlockWritable { * could be smaller as it does not count unused sectors where there are * used ones after it (i.e. fragmentation). * - * @since POI 5.0.0 + * @since 5.0.0 */ public int getOccupiedSize() { for (int k = _values.length - 1; k >= 0; k--) { diff --git a/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java b/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java index 8b6512d3f2..44645d7d89 100644 --- a/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java +++ b/poi/src/main/java/org/apache/poi/poifs/storage/HeaderBlock.java @@ -234,7 +234,7 @@ public final class HeaderBlock implements HeaderBlockConstants { /** * @return the number of property blocks - * @since POI 5.4.0 + * @since 5.4.0 */ public int getPropertyCount() { return _property_count; @@ -244,7 +244,7 @@ public final class HeaderBlock implements HeaderBlockConstants { * Set the number of property blocks * * @param property_count number of property blocks - * @since POI 5.4.0 + * @since 5.4.0 */ public void setPropertyCount(final int property_count) { this._property_count = property_count; diff --git a/poi/src/main/java/org/apache/poi/sl/draw/DrawFontManagerDefault.java b/poi/src/main/java/org/apache/poi/sl/draw/DrawFontManagerDefault.java index a5acccd023..9f11fc2e49 100644 --- a/poi/src/main/java/org/apache/poi/sl/draw/DrawFontManagerDefault.java +++ b/poi/src/main/java/org/apache/poi/sl/draw/DrawFontManagerDefault.java @@ -72,7 +72,7 @@ public class DrawFontManagerDefault implements DrawFontManager { * * @return the mapped string, typically consists of chars in the range of 0xf000 to 0xf0ff * - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public String mapFontCharset(Graphics2D graphics, FontInfo fontInfo, String text) { diff --git a/poi/src/main/java/org/apache/poi/sl/draw/ImageRenderer.java b/poi/src/main/java/org/apache/poi/sl/draw/ImageRenderer.java index 7c6e0762d8..0918223b31 100644 --- a/poi/src/main/java/org/apache/poi/sl/draw/ImageRenderer.java +++ b/poi/src/main/java/org/apache/poi/sl/draw/ImageRenderer.java @@ -135,7 +135,7 @@ public interface ImageRenderer { * @param dim the dimension in pixels of the returned image * @return the image as buffered image or null if image could not be loaded * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ BufferedImage getImage(Dimension2D dim); diff --git a/poi/src/main/java/org/apache/poi/sl/draw/SLGraphics.java b/poi/src/main/java/org/apache/poi/sl/draw/SLGraphics.java index 2cfa92c62f..47838a6ed5 100644 --- a/poi/src/main/java/org/apache/poi/sl/draw/SLGraphics.java +++ b/poi/src/main/java/org/apache/poi/sl/draw/SLGraphics.java @@ -385,7 +385,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see Graphics#clipRect * @see Graphics#setClip(int, int, int, int) * @see Graphics#setClip(Shape) - * @since JDK1.1 + * @since JDK1.1 */ @NotImplemented public Shape getClip(){ @@ -586,7 +586,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @param yPoints an array of y points * @param nPoints the total number of points * @see Graphics#drawPolygon(int[], int[], int) - * @since JDK1.1 + * @since JDK1.1 */ public void drawPolyline(int[] xPoints, int[] yPoints, int nPoints){ @@ -753,7 +753,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see Image * @see ImageObserver * @see ImageObserver#imageUpdate(Image, int, int, int, int, int) - * @since JDK1.1 + * @since JDK1.1 */ @NotImplemented public boolean drawImage(Image img, @@ -815,7 +815,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see Image * @see ImageObserver * @see ImageObserver#imageUpdate(Image, int, int, int, int, int) - * @since JDK1.1 + * @since JDK1.1 */ @NotImplemented public boolean drawImage(Image img, @@ -1043,7 +1043,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see Graphics#getClip() * @see Graphics#clipRect * @see Graphics#setClip(int, int, int, int) - * @since JDK1.1 + * @since JDK1.1 */ @NotImplemented public void setClip(Shape clip) { @@ -1065,7 +1065,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see Graphics#clipRect * @see Graphics#setClip(int, int, int, int) * @see Graphics#setClip(Shape) - * @since JDK1.1 + * @since JDK1.1 */ public Rectangle getClipBounds(){ logNotImplemented(); @@ -1130,7 +1130,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @param height the height of the new clip rectangle. * @see Graphics#clipRect * @see Graphics#setClip(Shape) - * @since JDK1.1 + * @since JDK1.1 */ public void setClip(int x, int y, int width, int height){ setClip(new Rectangle(x, y, width, height)); @@ -1220,7 +1220,7 @@ public class SLGraphics extends Graphics2D implements Cloneable { * @see FontRenderContext * @see Font#createGlyphVector(FontRenderContext,char[]) * @see TextLayout - * @since JDK1.2 + * @since JDK1.2 */ public FontRenderContext getFontRenderContext() { boolean isAntiAliased = RenderingHints.VALUE_TEXT_ANTIALIAS_ON.equals( diff --git a/poi/src/main/java/org/apache/poi/sl/draw/geom/CustomGeometry.java b/poi/src/main/java/org/apache/poi/sl/draw/geom/CustomGeometry.java index a5157c23d9..9733155f2d 100644 --- a/poi/src/main/java/org/apache/poi/sl/draw/geom/CustomGeometry.java +++ b/poi/src/main/java/org/apache/poi/sl/draw/geom/CustomGeometry.java @@ -112,7 +112,7 @@ public final class CustomGeometry implements Iterable{ } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/sl/extractor/SlideShowExtractor.java b/poi/src/main/java/org/apache/poi/sl/extractor/SlideShowExtractor.java index 3aa1681c41..5735434d30 100644 --- a/poi/src/main/java/org/apache/poi/sl/extractor/SlideShowExtractor.java +++ b/poi/src/main/java/org/apache/poi/sl/extractor/SlideShowExtractor.java @@ -49,7 +49,7 @@ import org.apache.poi.util.LocaleUtil; /** * Common SlideShow extractor * - * @since POI 4.0.0 + * @since 4.0.0 */ public class SlideShowExtractor< S extends Shape, diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Comment.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Comment.java index 43e46efec8..9b0b5bdcc0 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Comment.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Comment.java @@ -23,7 +23,7 @@ import java.util.Date; /** * Common interface for comments * - * @since POI 4.0.0 + * @since 4.0.0 */ public interface Comment { /** diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/HighlightColorSupport.java b/poi/src/main/java/org/apache/poi/sl/usermodel/HighlightColorSupport.java index cb8befe90b..5c727f2dd2 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/HighlightColorSupport.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/HighlightColorSupport.java @@ -28,7 +28,7 @@ import org.apache.poi.util.Internal; * An interface to provide support for get/set of highlight color in XLSFTextRuns instances. * Spec Ref: 21.1.2.3.4 (ECMA-376-1 5th ed. Ecma Office Open XML Part 1 - Fundamentals And Markup Language Reference.pdf) * - * @since POI 5.2.4 + * @since 5.2.4 */ @SuppressWarnings({"unused","java:S1452"}) public interface HighlightColorSupport @@ -42,7 +42,7 @@ public interface HighlightColorSupport * * @see org.apache.poi.sl.draw.DrawPaint#getPaint(java.awt.Graphics2D, PaintStyle) * @see SolidPaint#getSolidColor() - * @since POI 5.2.4 + * @since 5.2.4 */ PaintStyle getHighlightColor(); @@ -52,7 +52,7 @@ public interface HighlightColorSupport * @param color The highlight (background) color to set. * * @see org.apache.poi.sl.draw.DrawPaint#createSolidPaint(Color) - * @since POI 5.2.4 + * @since 5.2.4 */ void setHighlightColor(final PaintStyle color); @@ -60,7 +60,7 @@ public interface HighlightColorSupport * Sets the font highlight (background) color for this text run - convenience function * * @param color The highlight (background) color to set. - * @since POI 5.2.4 + * @since 5.2.4 */ void setHighlightColor(final Color color); diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Hyperlink.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Hyperlink.java index 381c928995..1fee46d83f 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Hyperlink.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Hyperlink.java @@ -19,7 +19,7 @@ package org.apache.poi.sl.usermodel; /** * A PowerPoint hyperlink - * @since POI 3.14 beta 2 + * @since 3.14 beta 2 */ public interface Hyperlink< S extends Shape, @@ -29,7 +29,7 @@ public interface Hyperlink< * Link to an email * * @param emailAddress the email address - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToEmail(String emailAddress); @@ -37,7 +37,7 @@ public interface Hyperlink< * Link to a web page / URL * * @param url the url - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToUrl(String url); @@ -45,35 +45,35 @@ public interface Hyperlink< * Link to a slide in this slideshow * * @param slide the linked slide - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToSlide(Slide slide); /** * Link to the next slide (relative from the current) * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToNextSlide(); /** * Link to the previous slide (relative from the current) * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToPreviousSlide(); /** * Link to the first slide in this slideshow * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToFirstSlide(); /** * Link to the last slide in this slideshow * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ void linkToLastSlide(); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Insets2D.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Insets2D.java index 7fec6354f5..2b79390be3 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Insets2D.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Insets2D.java @@ -91,7 +91,7 @@ public final class Insets2D implements Duplicatable { * bottom, and right are all equal. * @return true if the two insets are equal; * otherwise false. - * @since JDK1.1 + * @since JDK1.1 */ public boolean equals(Object obj) { if (obj instanceof Insets2D) { diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/MasterSheet.java b/poi/src/main/java/org/apache/poi/sl/usermodel/MasterSheet.java index 7b47024ebe..d5725c65c0 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/MasterSheet.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/MasterSheet.java @@ -26,7 +26,7 @@ public interface MasterSheet< * * @return the shape or {@code null} if it is not defined in this mastersheet * - * @since POI 4.0.0 + * @since 4.0.0 */ SimpleShape getPlaceholder(Placeholder type); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectData.java b/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectData.java index badf89e583..2cc1b5cae3 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectData.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectData.java @@ -31,7 +31,7 @@ import org.apache.poi.util.IOUtils; /** * Common interface for OLE shapes, i.e. shapes linked to embedded documents * - * @since POI 4.0.0 + * @since 4.0.0 */ public interface ObjectData { diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectShape.java b/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectShape.java index 8fad23ee9e..394b6fc138 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectShape.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/ObjectShape.java @@ -31,7 +31,7 @@ import org.apache.poi.util.IOUtils; /** * An shape which references an embedded OLE object * - * @since POI 4.0.0 + * @since 4.0.0 */ public interface ObjectShape< S extends Shape, diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/PictureShape.java b/poi/src/main/java/org/apache/poi/sl/usermodel/PictureShape.java index 4712ed03d4..9f967207bb 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/PictureShape.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/PictureShape.java @@ -35,7 +35,7 @@ public interface PictureShape< * * @return an alternative picture data * - * @since POI 4.1.0 + * @since 4.1.0 */ default PictureData getAlternativePictureData() { return null; } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/PlaceholderDetails.java b/poi/src/main/java/org/apache/poi/sl/usermodel/PlaceholderDetails.java index 5a4a947820..6d4324bac9 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/PlaceholderDetails.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/PlaceholderDetails.java @@ -23,7 +23,7 @@ import java.time.format.DateTimeFormatter; /** * Extended details about placholders * - * @since POI 4.0.0 + * @since 4.0.0 */ public interface PlaceholderDetails { enum PlaceholderSize { @@ -56,7 +56,7 @@ public interface PlaceholderDetails { * * @return the text of the shape / placeholder * - * @since POI 4.0.0 + * @since 4.0.0 */ String getText(); @@ -65,7 +65,7 @@ public interface PlaceholderDetails { * * @param text the placeholder text * - * @since POI 4.0.0 + * @since 4.0.0 */ void setText(String text); @@ -73,7 +73,7 @@ public interface PlaceholderDetails { /** * @return the stored / fixed user specified date * - * @since POI 5.2.0 + * @since 5.2.0 */ default String getUserDate() { return null; @@ -82,7 +82,7 @@ public interface PlaceholderDetails { /** * @return Get the date format for the datetime placeholder * - * @since POI 5.2.0 + * @since 5.2.0 */ default DateTimeFormatter getDateFormat() { return DateTimeFormatter.ISO_LOCAL_DATE; diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Shape.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Shape.java index 143c601983..747833418f 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Shape.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Shape.java @@ -42,7 +42,7 @@ public interface Shape< /** * @return human-readable name of this shape, e.g. "Rectange 3" * - * @since POI 4.0.0 + * @since 4.0.0 */ String getShapeName(); diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Sheet.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Sheet.java index 8be7ee46d5..10816bc428 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Sheet.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Sheet.java @@ -54,7 +54,7 @@ public interface Sheet< * @param placeholder the placeholder type * @return the placeholder details or {@code null}, if the placeholder isn't contained in the sheet * - * @since POI 4.0.0 + * @since 4.0.0 */ PlaceholderDetails getPlaceholderDetails(Placeholder placeholder); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/SimpleShape.java b/poi/src/main/java/org/apache/poi/sl/usermodel/SimpleShape.java index 507c3a7efe..25b514c841 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/SimpleShape.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/SimpleShape.java @@ -68,7 +68,7 @@ public interface SimpleShape< /** * @return an accessor for placeholder details * - * @since POI 4.0.0 + * @since 4.0.0 */ PlaceholderDetails getPlaceholderDetails(); @@ -78,7 +78,7 @@ public interface SimpleShape< * * @return {@code true} if the shape is a placeholder * - * @since POI 4.0.0 + * @since 4.0.0 */ boolean isPlaceholder(); @@ -108,7 +108,7 @@ public interface SimpleShape< * @return the hyperlink assigned to this shape * or null if not found. * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ Hyperlink getHyperlink(); @@ -118,7 +118,7 @@ public interface SimpleShape< * * @return the hyperlink assigned to this shape * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ Hyperlink createHyperlink(); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/Slide.java b/poi/src/main/java/org/apache/poi/sl/usermodel/Slide.java index 5224336722..d609a44565 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/Slide.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/Slide.java @@ -55,7 +55,7 @@ public interface Slide< * * @param placeholderRefShape the shape which references to the placeholder * @return {@code true} if the placeholder should be displayed/rendered - * @since POI 5.2.0 + * @since 5.2.0 */ default boolean getDisplayPlaceholder(SimpleShape placeholderRefShape) { return false; @@ -66,14 +66,14 @@ public interface Slide< * * @param hidden slide visibility, if {@code true} the slide is hidden, {@code false} shows the slide * - * @since POI 4.0.0 + * @since 4.0.0 */ void setHidden(boolean hidden); /** * @return the slide visibility, the slide is hidden when {@code true} - or shown when {@code false} * - * @since POI 4.0.0 + * @since 4.0.0 */ boolean isHidden(); @@ -86,14 +86,14 @@ public interface Slide< /** * @return the assigned slide layout * - * @since POI 4.0.0 + * @since 4.0.0 */ MasterSheet getSlideLayout(); /** * @return the slide name, defaults to "Slide[slideNumber]" * - * @since POI 4.0.0 + * @since 4.0.0 */ String getSlideName(); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java b/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java index 1ad08c2c88..e29cb4a381 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/SlideShow.java @@ -123,7 +123,7 @@ public interface SlideShow< /** * @return an extractor for the slideshow metadata * - * @since POI 4.0.0 + * @since 4.0.0 */ POITextExtractor getMetadataTextExtractor(); @@ -132,7 +132,7 @@ public interface SlideShow< * which is either a subclass of {@link org.apache.poi.POIDocument} * or {@link org.apache.poi.ooxml.POIXMLDocument} * - * @since POI 4.0.0 + * @since 4.0.0 */ Object getPersistDocument(); diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/TableCell.java b/poi/src/main/java/org/apache/poi/sl/usermodel/TableCell.java index 4bc5e33278..977c408215 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/TableCell.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/TableCell.java @@ -89,7 +89,7 @@ public interface TableCell< * * @return the grid span * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ int getGridSpan(); @@ -98,7 +98,7 @@ public interface TableCell< * * @return the row span * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ int getRowSpan(); @@ -108,7 +108,7 @@ public interface TableCell< * * @return true if this a merged cell * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ boolean isMerged(); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/TextParagraph.java b/poi/src/main/java/org/apache/poi/sl/usermodel/TextParagraph.java index 5318752cde..d83590caef 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/TextParagraph.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/TextParagraph.java @@ -369,7 +369,7 @@ public interface TextParagraph< * * @return true if this paragraph is part of a header or footer placeholder * - * @since POI 3.15-beta2 + * @since 3.15-beta2 */ boolean isHeaderOrFooter(); @@ -382,7 +382,7 @@ public interface TextParagraph< * * @return the tabstop collection or {@code null} if no tabstops are defined * - * @since POI 4.0.0 + * @since 4.0.0 */ @SuppressWarnings("java:S1452") List getTabStops(); @@ -390,7 +390,7 @@ public interface TextParagraph< /** * Set the {@link TabStop} collection * - * @since POI 4.0.0 + * @since 4.0.0 */ void addTabStops(double positionInPoints, TabStop.TabStopType tabStopType); @@ -398,7 +398,7 @@ public interface TextParagraph< * Removes the tabstops of this paragraphs. * This doesn't affect inherited tabstops, e.g. inherited by the slide master * - * @since POI 4.0.0 + * @since 4.0.0 */ void clearTabStops(); } \ No newline at end of file diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/TextRun.java b/poi/src/main/java/org/apache/poi/sl/usermodel/TextRun.java index 2c8f4b6df5..3f5ba7c243 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/TextRun.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/TextRun.java @@ -139,7 +139,7 @@ public interface TextRun { * if {@code null}, the font group matching the first character will be returned * @return font info or {@code null} if not set * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ FontInfo getFontInfo(FontGroup fontGroup); @@ -150,7 +150,7 @@ public interface TextRun { * The value of {@code null} removes the run specific font setting, so the default setting is activated again. * @param fontGroup the font group, i.e. the range of glyphs to be covered. defaults to latin, if {@code null}. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ void setFontInfo(FontInfo fontInfo, FontGroup fontGroup); @@ -222,7 +222,7 @@ public interface TextRun { * * @return the associated hyperlink or null if no hyperlink was set * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ Hyperlink getHyperlink(); @@ -233,7 +233,7 @@ public interface TextRun { * * @return the associated hyperlink * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ Hyperlink createHyperlink(); @@ -248,7 +248,7 @@ public interface TextRun { /** * @return the paragraph which contains this TextRun * - * @since POI 4.1.0 + * @since 4.1.0 */ TextParagraph getParagraph(); } diff --git a/poi/src/main/java/org/apache/poi/sl/usermodel/TextShape.java b/poi/src/main/java/org/apache/poi/sl/usermodel/TextShape.java index 8219836281..6bdb707bc1 100644 --- a/poi/src/main/java/org/apache/poi/sl/usermodel/TextShape.java +++ b/poi/src/main/java/org/apache/poi/sl/usermodel/TextShape.java @@ -145,7 +145,7 @@ public interface TextShape< * * @return the text string for this textbox. * - * @since POI 3.14-Beta2 + * @since 3.14-Beta2 */ String getText(); @@ -169,7 +169,7 @@ public interface TextShape< * @param newParagraph if true, a new paragraph will be added, * which will contain the added text * - * @since POI 3.14-Beta1 + * @since 3.14-Beta1 */ TextRun appendText(String text, boolean newParagraph); @@ -204,7 +204,7 @@ public interface TextShape< * * @return the cumulative height occupied by the text * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ double getTextHeight(Graphics2D graphics); @@ -293,7 +293,7 @@ public interface TextShape< * * @return a {@code Rectangle2D} that is the bounds of this shape. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ Rectangle2D resizeToFitText(); @@ -304,7 +304,7 @@ public interface TextShape< * * @return a {@code Rectangle2D} that is the bounds of this shape. * - * @since POI 3.17-beta2 + * @since 3.17-beta2 */ Rectangle2D resizeToFitText(Graphics2D graphics); diff --git a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationSheet.java b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationSheet.java index f9d7cd053a..53756db4c5 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationSheet.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationSheet.java @@ -35,20 +35,20 @@ public interface EvaluationSheet { * * @see WorkbookEvaluator#clearAllCachedResultValues() * @see EvaluationWorkbook#clearAllCachedResultValues() - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ void clearAllCachedResultValues(); /** * @return last row index referenced on this sheet, for evaluation optimization - * @since POI 4.0.0 + * @since 4.0.0 */ int getLastRowNum(); /** * Used by SUBTOTAL and similar functions that have options to ignore hidden rows * @return true if the row is hidden, false if not - * @since POI 4.1.0 + * @since 4.1.0 */ boolean isRowHidden(int rowIndex); } diff --git a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java index 026df65c0f..7232759b51 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java @@ -101,7 +101,7 @@ public interface EvaluationWorkbook { * Implementations must call the same method on all referenced {@link EvaluationSheet} instances, as well as clearing local caches. * @see WorkbookEvaluator#clearAllCachedResultValues() * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ void clearAllCachedResultValues(); diff --git a/poi/src/main/java/org/apache/poi/ss/formula/FormulaShifter.java b/poi/src/main/java/org/apache/poi/ss/formula/FormulaShifter.java index 782063a481..0af837c30a 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/FormulaShifter.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/FormulaShifter.java @@ -41,9 +41,9 @@ public final class FormulaShifter { private enum ShiftMode { RowMove, RowCopy, - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ ColumnMove, - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ ColumnCopy, SheetMove, } @@ -116,7 +116,7 @@ public final class FormulaShifter { } /** - * @since POI 4.0.0 + * @since 4.0.0 */ public static FormulaShifter createForColumnShift(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version) { @@ -124,7 +124,7 @@ public final class FormulaShifter { } /** - * @since POI 4.0.0 + * @since 4.0.0 */ public static FormulaShifter createForColumnCopy(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version) { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/FormulaType.java b/poi/src/main/java/org/apache/poi/ss/formula/FormulaType.java index 5986132b29..1d4177784e 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/FormulaType.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/FormulaType.java @@ -58,7 +58,7 @@ public enum FormulaType { /** formula is expected to return a single value vs. multiple values */ private final boolean isSingleValue ; /** - * @since POI 3.15 beta 3. + * @since 3.15 beta 3. */ FormulaType(boolean singleValue) { this.isSingleValue = singleValue; @@ -75,7 +75,7 @@ public enum FormulaType { * Used to transition from {@code int}s (possibly stored in the Excel file) to {@code FormulaType}s. * @return FormulaType * @throws IllegalArgumentException if code is out of range - * @since POI 3.15 beta 3. + * @since 3.15 beta 3. */ public static FormulaType forInt(int code) { if (code >= 0 && code < values().length) { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/LazyRefEval.java b/poi/src/main/java/org/apache/poi/ss/formula/LazyRefEval.java index b48bed9c0b..651ddc2f73 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/LazyRefEval.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/LazyRefEval.java @@ -41,7 +41,7 @@ public final class LazyRefEval extends RefEvalBase { /** * @return the Eval of the first sheet associated with this LazyRefEval - * @since POI 5.4.0 + * @since 5.4.0 */ public ValueEval getInnerValueEvalForFirstSheet() { return _evaluator.getEvalForCell(_evaluator.getFirstSheetIndex(), getRow(), getColumn()); diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java index a34b8b370d..77a4b1109c 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java @@ -288,7 +288,7 @@ public final class AnalysisToolPak implements UDFFinder { * @param func the function to register * @param force force registration even if the function is already registered or unknown to POI * @throws IllegalArgumentException if the function is unknown or already registered (and `force` is not true). - * @since POI 5.5.0 + * @since 5.5.0 */ public static void registerFunction(String name, FreeRefFunction func, boolean force) { AnalysisToolPak inst = (AnalysisToolPak)instance; diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankExcFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankExcFunction.java index e638fddd61..ac6ea7af21 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankExcFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankExcFunction.java @@ -41,7 +41,7 @@ import java.util.List; * * @see PercentRank * @see PercentRankIncFunction - * @since POI 5.1.0 + * @since 5.1.0 */ final class PercentRankExcFunction implements FreeRefFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankIncFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankIncFunction.java index fd47478b97..6dc60022a8 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankIncFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/PercentRankIncFunction.java @@ -38,7 +38,7 @@ import org.apache.poi.ss.formula.functions.PercentRank; * * @see PercentRank * @see PercentRankExcFunction - * @since POI 5.1.0 + * @since 5.1.0 */ final class PercentRankIncFunction implements FreeRefFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/TextJoinFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/TextJoinFunction.java index 45b3ec31ac..6315af4544 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/TextJoinFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/TextJoinFunction.java @@ -38,7 +38,7 @@ import java.util.List; * text2 ... Optional. Additional text items to be joined. There can be a maximum of 252 text arguments for the text items, including text1. * Each can be a text string, or array of strings, such as a range of cells.
* - * @since POI 5.1.0 + * @since 5.1.0 */ final class TextJoinFunction implements FreeRefFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/WorkdayIntlFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/WorkdayIntlFunction.java index 7067ccb266..158071b141 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/WorkdayIntlFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/WorkdayIntlFunction.java @@ -34,7 +34,7 @@ import org.apache.poi.ss.usermodel.DateUtil; * WORKDAY.INTL(startDate, days, weekendType, holidays) *

* https://support.microsoft.com/en-us/office/workday-intl-function-a378391c-9ba7-4678-8a39-39611a9bf81d - * @since POI 5.2.0 + * @since 5.2.0 */ final class WorkdayIntlFunction implements FreeRefFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/XLookupFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/XLookupFunction.java index ccef07a1d7..db767ba687 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/XLookupFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/XLookupFunction.java @@ -32,7 +32,7 @@ import org.apache.poi.ss.formula.functions.LookupUtils; * * https://support.microsoft.com/en-us/office/xlookup-function-b7fd680e-6d10-43e6-84f9-88eae8bf5929 * - * @since POI 5.2.0 + * @since 5.2.0 */ final class XLookupFunction implements FreeRefFunction, ArrayFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/atp/XMatchFunction.java b/poi/src/main/java/org/apache/poi/ss/formula/atp/XMatchFunction.java index f29a393f5f..777a005cf6 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/atp/XMatchFunction.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/atp/XMatchFunction.java @@ -31,7 +31,7 @@ import org.apache.poi.ss.formula.functions.LookupUtils; * * https://support.microsoft.com/en-us/office/xmatch-function-d966da31-7a6b-4a13-a1c6-5a33ed6a0312 * - * @since POI 5.2.0 + * @since 5.2.0 */ final class XMatchFunction implements FreeRefFunction { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java index 8fe9d0cbbd..b09ead178c 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java @@ -55,7 +55,7 @@ final class ForkedEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#getlastRowNum() - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public int getLastRowNum() { @@ -64,7 +64,7 @@ final class ForkedEvaluationSheet implements EvaluationSheet { /* (non-Javadoc) * @see org.apache.poi.ss.formula.EvaluationSheet#isRowHidden(int) - * @since POI 4.1.0 + * @since 4.1.0 */ @Override public boolean isRowHidden(int rowIndex) { @@ -126,7 +126,7 @@ final class ForkedEvaluationSheet implements EvaluationSheet { * leave the map alone, if it needs resetting, reusing this class is probably a bad idea. * @see org.apache.poi.ss.formula.EvaluationSheet#clearAllCachedResultValues() * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java index 1789381d6e..1234283e97 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java @@ -165,7 +165,7 @@ final class ForkedEvaluationWorkbook implements EvaluationWorkbook { * leave the map alone, if it needs resetting, reusing this class is probably a bad idea. * @see org.apache.poi.ss.formula.EvaluationSheet#clearAllCachedResultValues() * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Override public void clearAllCachedResultValues() { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/PercentRank.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/PercentRank.java index a68749d9fd..01216f0709 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/functions/PercentRank.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/PercentRank.java @@ -40,7 +40,7 @@ import java.util.List; *
* Returns a number between 0 and 1 representing a percentage. * - * @since POI 5.1.0 + * @since 5.1.0 */ public final class PercentRank implements Function { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/BorderFormatting.java b/poi/src/main/java/org/apache/poi/ss/usermodel/BorderFormatting.java index 985a215409..301da5efb3 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/BorderFormatting.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/BorderFormatting.java @@ -25,19 +25,19 @@ package org.apache.poi.ss.usermodel; */ public interface BorderFormatting { - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ BorderStyle getBorderBottom(); - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ BorderStyle getBorderDiagonal(); - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ BorderStyle getBorderLeft(); - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ BorderStyle getBorderRight(); - /** @since POI 4.0.0 */ + /** @since 4.0.0 */ BorderStyle getBorderTop(); /** @@ -70,26 +70,26 @@ public interface BorderFormatting { /** * Range internal borders. Only relevant for range styles, such as table formatting - * @since 3.17 beta 1 + * @since 3.17 beta 1 * @return color index */ short getVerticalBorderColor(); /** * Range internal borders. Only relevant for range styles, such as table formatting - * @since 3.17 beta 1 + * @since 3.17 beta 1 * @return color */ Color getVerticalBorderColorColor(); /** * Range internal borders. Only relevant for range styles, such as table formatting - * @since 3.17 beta 1 + * @since 3.17 beta 1 * @return color index */ short getHorizontalBorderColor(); /** * Range internal borders. Only relevant for range styles, such as table formatting - * @since 3.17 beta 1 + * @since 3.17 beta 1 * @return color */ Color getHorizontalBorderColorColor(); diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyCategory.java b/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyCategory.java index 257d45abac..e4cfb052c6 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyCategory.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyCategory.java @@ -22,7 +22,7 @@ package org.apache.poi.ss.usermodel; * The CellPropertyCategory enum represents the different categories of cell properties. * Each category is used to classify and organize the cell properties based on their characteristics. * - * @since POI 5.4.0 + * @since 5.4.0 */ public enum CellPropertyCategory { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyType.java b/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyType.java index f876e1a15f..abf942dd5a 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyType.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/CellPropertyType.java @@ -22,7 +22,7 @@ package org.apache.poi.ss.usermodel; * Each type is associated with a specific category {@link CellPropertyCategory}, which classifies and organizes * the properties based on their characteristics. * - * @since POI 5.4.0 + * @since 5.4.0 */ public enum CellPropertyType { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/CellReferenceType.java b/poi/src/main/java/org/apache/poi/ss/usermodel/CellReferenceType.java index c4f9bc0c38..aea203f5ed 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/CellReferenceType.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/CellReferenceType.java @@ -19,7 +19,7 @@ package org.apache.poi.ss.usermodel; /** * Types of cell references. - * @since POI 5.2.1 + * @since 5.2.1 */ public enum CellReferenceType { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/CellStyle.java b/poi/src/main/java/org/apache/poi/ss/usermodel/CellStyle.java index e02b5ba383..b6c810e43a 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/CellStyle.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/CellStyle.java @@ -177,56 +177,56 @@ public interface CellStyle { /** * set the type of border to use for the left border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ void setBorderLeft(BorderStyle border); /** * get the type of border to use for the left border of the cell * @return border type - * @since POI 4.0.0 + * @since 4.0.0 */ BorderStyle getBorderLeft(); /** * set the type of border to use for the right border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ void setBorderRight(BorderStyle border); /** * get the type of border to use for the right border of the cell * @return border type - * @since POI 4.0.0 + * @since 4.0.0 */ BorderStyle getBorderRight(); /** * set the type of border to use for the top border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ void setBorderTop(BorderStyle border); /** * get the type of border to use for the top border of the cell * @return border type - * @since POI 4.0.0 + * @since 4.0.0 */ BorderStyle getBorderTop(); /** * set the type of border to use for the bottom border of the cell * @param border type - * @since POI 3.15 + * @since 3.15 */ void setBorderBottom(BorderStyle border); /** * get the type of border to use for the bottom border of the cell * @return border type - * @since POI 4.0.0 + * @since 4.0.0 */ BorderStyle getBorderBottom(); @@ -282,7 +282,7 @@ public interface CellStyle { * other values * * @param fp fill pattern (set to {@link FillPatternType#SOLID_FOREGROUND} to fill w/foreground color) - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ void setFillPattern(FillPatternType fp); @@ -290,7 +290,7 @@ public interface CellStyle { * Get the fill pattern * * @return the fill pattern, default value is {@link FillPatternType#NO_FILL} - * @since POI 4.0.0 + * @since 4.0.0 */ FillPatternType getFillPattern(); @@ -306,7 +306,7 @@ public interface CellStyle { * Uses a {@link org.apache.poi.ss.usermodel.Color} instead of an indexed color. * * @param color org.apache.poi.ss.usermodel.Color to set - * @since POI 5.2.3 + * @since 5.2.3 */ void setFillBackgroundColor(Color color); @@ -338,7 +338,7 @@ public interface CellStyle { * Uses a {@link org.apache.poi.ss.usermodel.Color} instead of an indexed color. * * @param color org.apache.poi.ss.usermodel.Color to set - * @since POI 5.2.3 + * @since 5.2.3 */ void setFillForegroundColor(Color color); @@ -399,7 +399,7 @@ public interface CellStyle { * * @return map of format properties * @see org.apache.poi.ss.util.CellUtil#getFormatProperties(CellStyle) - * @since POI 5.5.0 + * @since 5.5.0 */ EnumMap getFormatProperties(); @@ -409,7 +409,7 @@ public interface CellStyle { * The API is public just in case users find that the CellStyle implementations * are not calling this method when they should. * - * @since POI 5.5.0 + * @since 5.5.0 */ void invalidateCachedProperties(); } diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/CellType.java b/poi/src/main/java/org/apache/poi/ss/usermodel/CellType.java index 510889ec77..d02b486a46 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/CellType.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/CellType.java @@ -21,7 +21,7 @@ import org.apache.poi.ss.formula.FormulaType; import org.apache.poi.util.Internal; /** - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public enum CellType { /** @@ -63,7 +63,7 @@ public enum CellType { ERROR(5); /** - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 * @deprecated POI 3.15 beta 3 */ @Deprecated @@ -74,7 +74,7 @@ public enum CellType { } /** - * @since POI 3.15 beta 3. + * @since 3.15 beta 3. * @deprecated POI 3.15 beta 3. Used to transition code from ints to CellTypes. */ @Deprecated @@ -88,7 +88,7 @@ public enum CellType { } /** - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 * @deprecated POI 3.15 beta 3 */ @Deprecated diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/ChildAnchor.java b/poi/src/main/java/org/apache/poi/ss/usermodel/ChildAnchor.java index 92a0469e52..08d3ac3b3a 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/ChildAnchor.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/ChildAnchor.java @@ -23,7 +23,7 @@ package org.apache.poi.ss.usermodel; * An anchor is what specifics the position of a shape within a client object * or within another containing shape. * - * @since POI 3.16-beta2 + * @since 3.16-beta2 */ public interface ChildAnchor { /** diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/ClientAnchor.java b/poi/src/main/java/org/apache/poi/ss/usermodel/ClientAnchor.java index 77c09c17b0..4469f4ba09 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/ClientAnchor.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/ClientAnchor.java @@ -34,7 +34,7 @@ import org.apache.poi.util.Internal; public interface ClientAnchor { /** - * @since POI 3.14beta1 + * @since 3.14beta1 */ public static enum AnchorType { /** @@ -260,7 +260,7 @@ public interface ClientAnchor { /** * Sets the anchor type * @param anchorType the anchor type to set - * @since POI 3.14 + * @since 3.14 */ public void setAnchorType( AnchorType anchorType ); diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/DataFormatter.java b/poi/src/main/java/org/apache/poi/ss/usermodel/DataFormatter.java index e0ceb03a7b..0acc9d86dd 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/DataFormatter.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/DataFormatter.java @@ -279,7 +279,7 @@ public class DataFormatter { /** * @param emulateCSV whether to emulate CSV output (default false). - * @since POI 5.2.0 + * @since 5.2.0 */ public void setEmulateCSV(boolean emulateCSV) { this.emulateCSV = emulateCSV; @@ -287,7 +287,7 @@ public class DataFormatter { /** * @return whether to emulate CSV output (default false). - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean isEmulateCSV() { return emulateCSV; @@ -298,7 +298,7 @@ public class DataFormatter { * for cells with formulas, we will return the cached value for the cell (if available), * otherwise - we return the formula itself. * The default is false and this means we return the formula itself. - * @since POI 5.2.0 + * @since 5.2.0 */ public void setUseCachedValuesForFormulaCells(boolean useCachedValuesForFormulaCells) { this.useCachedValuesForFormulaCells = useCachedValuesForFormulaCells; @@ -309,7 +309,7 @@ public class DataFormatter { * for cells with formulas, we will return the cached value for the cell (if available), * otherwise - we return the formula itself. * The default is false and this means we return the formula itself. - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean useCachedValuesForFormulaCells() { return useCachedValuesForFormulaCells; @@ -318,7 +318,7 @@ public class DataFormatter { /** * @param use4DigitYearsInAllDateFormats set to true if you want to have all dates formatted with 4 digit * years (even if the format associated with the cell specifies just 2) - * @since POI 5.2.0 + * @since 5.2.0 */ public void setUse4DigitYearsInAllDateFormats(boolean use4DigitYearsInAllDateFormats) { this.use4DigitYearsInAllDateFormats = use4DigitYearsInAllDateFormats; @@ -327,7 +327,7 @@ public class DataFormatter { /** * @return use4DigitYearsInAllDateFormats set to true if you want to have all dates formatted with 4 digit * years (even if the format associated with the cell specifies just 2) - * @since POI 5.2.0 + * @since 5.2.0 */ public boolean use4DigitYearsInAllDateFormats() { return use4DigitYearsInAllDateFormats; diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java b/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java index 452c8948bb..4983feba62 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/DateUtil.java @@ -1008,7 +1008,7 @@ public class DateUtil { * If disabled, the cache will not be used and each check will be performed independently. * * @param enable true to enable the cache, false to disable it (enabled, by default) - * @since POI 5.5.0 + * @since 5.5.0 */ public static void enableThreadLocalCache(final boolean enable) { // enable thread-local cache for date format checking diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/ObjectData.java b/poi/src/main/java/org/apache/poi/ss/usermodel/ObjectData.java index 3d21b1a8d2..6d02ee2ca7 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/ObjectData.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/ObjectData.java @@ -24,7 +24,7 @@ import org.apache.poi.poifs.filesystem.DirectoryEntry; /** * Common interface for OLE shapes, i.e. shapes linked to embedded documents * - * @since POI 3.16-beta2 + * @since 3.16-beta2 */ public interface ObjectData extends SimpleShape { /** diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/PageMargin.java b/poi/src/main/java/org/apache/poi/ss/usermodel/PageMargin.java index 907886a97d..777d6cca05 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/PageMargin.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/PageMargin.java @@ -29,7 +29,7 @@ import java.util.Map; * empty space on the edges of each printed page *

* - * @since POI 5.2.3 + * @since 5.2.3 */ public enum PageMargin { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/PaneType.java b/poi/src/main/java/org/apache/poi/ss/usermodel/PaneType.java index 899079c140..b3d89e5c4a 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/PaneType.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/PaneType.java @@ -18,7 +18,7 @@ package org.apache.poi.ss.usermodel; /** * Type of pane used in sheet. - * @since POI 5.2.3 + * @since 5.2.3 */ public enum PaneType { LOWER_RIGHT, UPPER_RIGHT, LOWER_LEFT, UPPER_LEFT diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Row.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Row.java index 14303dc06f..964abda1fc 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Row.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Row.java @@ -232,7 +232,7 @@ public interface Row extends Iterable { * @return Cell spliterator of the physically defined cells. Note element 4 may * actually be row cell depending on how many are defined! * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override default Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Shape.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Shape.java index f9e3874a75..0180ccc8bf 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Shape.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Shape.java @@ -20,7 +20,7 @@ package org.apache.poi.ss.usermodel; /** * Common interface for all drawing shapes * - * @since POI 3.16-beta2 + * @since 3.16-beta2 */ public interface Shape { /** diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/ShapeContainer.java b/poi/src/main/java/org/apache/poi/ss/usermodel/ShapeContainer.java index d0867b9b07..a267cce5ea 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/ShapeContainer.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/ShapeContainer.java @@ -20,7 +20,7 @@ package org.apache.poi.ss.usermodel; /** * A common interface for shape groups. * - * @since POI 3.16-beta2 + * @since 3.16-beta2 */ public interface ShapeContainer extends Iterable { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java index 68d2c21962..f77471a56c 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java @@ -392,7 +392,7 @@ public interface Sheet extends Iterable { * @return a spliterator of the PHYSICAL rows. Meaning the 3rd element may not * be the third row if say for instance the second row is undefined. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override default Spliterator spliterator() { @@ -635,7 +635,7 @@ public interface Sheet extends Iterable { * * @param margin which margin to get * @return the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ double getMargin(PageMargin margin); @@ -655,7 +655,7 @@ public interface Sheet extends Iterable { * * @param margin which margin to set * @param size the size of the margin - * @since POI 5.2.3 + * @since 5.2.3 */ void setMargin(PageMargin margin, double size); @@ -816,7 +816,7 @@ public interface Sheet extends Iterable { * @param leftmostColumn Left column visible in right pane. * @param activePane Active pane. * @see PaneType - * @since POI 5.2.3 + * @since 5.2.3 */ void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, PaneType activePane); @@ -1233,7 +1233,7 @@ public interface Sheet extends Iterable { * * @param addr The address of the cell containing the hyperlink * @return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ Hyperlink getHyperlink(CellAddress addr); diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/SimpleShape.java b/poi/src/main/java/org/apache/poi/ss/usermodel/SimpleShape.java index fe97c850f3..6f3780e588 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/SimpleShape.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/SimpleShape.java @@ -20,13 +20,13 @@ package org.apache.poi.ss.usermodel; /** * A common interface for simple shapes. * - * @since POI 3.16-beta2 + * @since 3.16-beta2 */ public interface SimpleShape extends Shape { /** * @return the shape id, which is unique within the sheet * - * @since POI 3.17-beta1 + * @since 3.17-beta1 */ int getShapeId(); } diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java index 790ae99f7b..e3c48ce34b 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Workbook.java @@ -235,7 +235,7 @@ public interface Workbook extends Closeable, Iterable { * * @return a spliterator of the sheets. * - * @since POI 5.2.0 + * @since 5.2.0 */ @Override default Spliterator spliterator() { @@ -545,7 +545,7 @@ public interface Workbook extends Closeable, Iterable { * * @param sheetIx the index of the sheet * @return the sheet visibility - * @since POI 3.16 beta 2 + * @since 3.16 beta 2 */ SheetVisibility getSheetVisibility(int sheetIx); @@ -557,7 +557,7 @@ public interface Workbook extends Closeable, Iterable { * * @param sheetIx the sheet index (0-based) * @param visibility the sheet visibility to set - * @since POI 3.16 beta 2 + * @since 3.16 beta 2 */ void setSheetVisibility(int sheetIx, SheetVisibility visibility); @@ -623,13 +623,13 @@ public interface Workbook extends Closeable, Iterable { /** * @return the type of cell references used - * @since POI 5.2.1 + * @since 5.2.1 */ CellReferenceType getCellReferenceType(); /** * @param cellReferenceType the type of cell references used - * @since POI 5.2.1 + * @since 5.2.1 */ void setCellReferenceType(CellReferenceType cellReferenceType); } diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/BaseRowColShifter.java b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/BaseRowColShifter.java index a044932cb8..5e2400c556 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/BaseRowColShifter.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/BaseRowColShifter.java @@ -31,7 +31,7 @@ import java.util.List; * Class for code common to {@link RowShifter} and {@link ColumnShifter} * Helper for shifting rows up or down and columns left and right * - * @since POI 4.0.0 + * @since 4.0.0 */ @Internal public abstract class BaseRowColShifter { diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/ColumnShifter.java b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/ColumnShifter.java index cbd6f784c9..32c2d52220 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/ColumnShifter.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/helpers/ColumnShifter.java @@ -30,7 +30,7 @@ import org.apache.poi.util.Beta; /** * Helper for shifting columns up or down * - * @since POI 4.0.0 + * @since 4.0.0 */ // non-Javadoc: This abstract class exists to consolidate duplicated code between XSSFColumnShifter and HSSFColumnShifter // (currently methods sprinkled throughout HSSFSheet) @@ -50,7 +50,7 @@ public abstract class ColumnShifter extends BaseRowColShifter { * @param endColumn the column to end shifting * @param n the number of columns to shift * @return an array of affected merged regions, doesn't contain deleted ones - * @since POI 4.0.0 + * @since 4.0.0 */ // Keep this code in sync with {@link RowShifter#shiftMergedRegions} @Override diff --git a/poi/src/main/java/org/apache/poi/ss/util/CellAddress.java b/poi/src/main/java/org/apache/poi/ss/util/CellAddress.java index 06add8711e..3aa30159b6 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/CellAddress.java +++ b/poi/src/main/java/org/apache/poi/ss/util/CellAddress.java @@ -175,7 +175,7 @@ public class CellAddress implements Comparable { /** * @return R1C1-style cell address string representation * @see #formatAsString() - * @since POI 5.2.1 + * @since 5.2.1 */ public String formatAsR1C1String() { return new CellReference(_row, _col).formatAsR1C1String(); diff --git a/poi/src/main/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/poi/src/main/java/org/apache/poi/ss/util/CellRangeAddressBase.java index d8852221c4..7153dff29a 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/CellRangeAddressBase.java +++ b/poi/src/main/java/org/apache/poi/ss/util/CellRangeAddressBase.java @@ -284,7 +284,7 @@ public abstract class CellRangeAddressBase implements Iterable, Dup /** * Returns an iterator over the CellAddresses in this cell range in row-major order. - * @since POI 4.0.0 + * @since 4.0.0 */ @Override public Iterator iterator() { @@ -293,7 +293,7 @@ public abstract class CellRangeAddressBase implements Iterable, Dup /** * Returns a spliterator over the CellAddresses in this cell range in row-major order. - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/ss/util/CellReference.java b/poi/src/main/java/org/apache/poi/ss/util/CellReference.java index da1202c283..61f2865ad6 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/CellReference.java +++ b/poi/src/main/java/org/apache/poi/ss/util/CellReference.java @@ -508,7 +508,7 @@ public class CellReference implements GenericRecord { * @return the text representation of this cell reference as it would appear in a formula. * @see #formatAsString() * @see #formatAsR1C1String(boolean) - * @since POI 5.2.1 + * @since 5.2.1 */ public String formatAsR1C1String() { return formatAsR1C1String(true); @@ -560,7 +560,7 @@ public class CellReference implements GenericRecord { * @return the text representation of this cell reference as it would appear in a formula. * @see #formatAsString(boolean) * @see #formatAsR1C1String() - * @since POI 5.2.1 + * @since 5.2.1 */ public String formatAsR1C1String(boolean includeSheetName) { StringBuilder sb = new StringBuilder(32); diff --git a/poi/src/main/java/org/apache/poi/ss/util/CellUtil.java b/poi/src/main/java/org/apache/poi/ss/util/CellUtil.java index e1e758fd2a..b8de646192 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/CellUtil.java +++ b/poi/src/main/java/org/apache/poi/ss/util/CellUtil.java @@ -397,7 +397,7 @@ public final class CellUtil { * @param context The context for copying, see {@link CellCopyContext} * @throws IllegalArgumentException if copy cell style and srcCell is from a different workbook * @throws IllegalStateException if srcCell hyperlink is not an instance of {@link Duplicatable} - * @since POI 5.2.0 + * @since 5.2.0 */ @Beta public static void copyCell(Cell srcCell, Cell destCell, CellCopyPolicy policy, CellCopyContext context) { @@ -499,7 +499,7 @@ public final class CellUtil { * @param align the horizontal alignment to use. * * @see HorizontalAlignment for alignment options - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public static void setAlignment(Cell cell, HorizontalAlignment align) { setCellStyleProperty(cell, CellPropertyType.ALIGNMENT, align); @@ -518,7 +518,7 @@ public final class CellUtil { * @param align the vertical alignment to use. * * @see VerticalAlignment for alignment options - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ public static void setVerticalAlignment(Cell cell, VerticalAlignment align) { setCellStyleProperty(cell, CellPropertyType.VERTICAL_ALIGNMENT, align); @@ -568,7 +568,7 @@ public final class CellUtil { * * @param cell The cell to change the style of * @param properties The properties to be added to a cell style, as {property: propertyValue}. - * @since POI 3.14 beta 2 + * @since 3.14 beta 2 * @deprecated as of POI 5.4.0. See {@link #setCellStylePropertiesEnum(Cell, Map)} */ @Deprecated @@ -602,7 +602,7 @@ public final class CellUtil { * * @param cell The cell to change the style of * @param properties The properties to be added to a cell style, as {property: propertyValue}. - * @since POI 5.4.0 + * @since 5.4.0 */ public static void setCellStylePropertiesEnum(Cell cell, Map properties) { setCellStyleProperties(cell, properties, false); @@ -688,7 +688,7 @@ public final class CellUtil { * @param property The name of the property that is to be changed. * @param propertyValue The value of the property that is to be changed. * @throws NullPointerException if {@code cell} or {@code property} is null - * @since POI 5.4.0 + * @since 5.4.0 */ public static void setCellStyleProperty(Cell cell, CellPropertyType property, Object propertyValue) { if (cell == null) { @@ -748,7 +748,7 @@ public final class CellUtil { * @param style cell style * @return map of format properties (CellPropertyType -> Object) * @see #setFormatProperties(CellStyle, Workbook, Map) - * @since POI 5.5.0 + * @since 5.5.0 */ public static EnumMap getFormatProperties(CellStyle style) { EnumMap properties = new EnumMap<>(CellPropertyType.class); @@ -881,7 +881,7 @@ public final class CellUtil { * @param dest destination cell style * @param destWorkbook destination workbook (can be null but some font info will not be copied if null is passed) * @throws IllegalArgumentException if source or destination styles are null - * @since POI 5.5.0 + * @since 5.5.0 */ @Internal public static void cloneStyle(CellStyle src, CellStyle dest, Workbook destWorkbook) { @@ -984,7 +984,7 @@ public final class CellUtil { * @param properties map of named properties (CellPropertyType -> Object) * @param property property * @return FillPatternType style if set, otherwise {@link FillPatternType#NO_FILL} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ private static FillPatternType getFillPattern(Map properties, CellPropertyType property) { Object value = properties.get(property); @@ -1011,7 +1011,7 @@ public final class CellUtil { * @param properties map of named properties (CellPropertyType -> Object) * @param property property * @return HorizontalAlignment style if set, otherwise {@link HorizontalAlignment#GENERAL} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ private static HorizontalAlignment getHorizontalAlignment(Map properties, CellPropertyType property) { Object value = properties.get(property); @@ -1038,7 +1038,7 @@ public final class CellUtil { * @param properties map of named properties (CellPropertyType -> Object) * @param property property * @return VerticalAlignment style if set, otherwise {@link VerticalAlignment#BOTTOM} - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ private static VerticalAlignment getVerticalAlignment(Map properties, CellPropertyType property) { Object value = properties.get(property); diff --git a/poi/src/main/java/org/apache/poi/ss/util/PaneInformation.java b/poi/src/main/java/org/apache/poi/ss/util/PaneInformation.java index d62648a998..53520307e4 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/PaneInformation.java +++ b/poi/src/main/java/org/apache/poi/ss/util/PaneInformation.java @@ -102,7 +102,7 @@ public class PaneInformation /** * @return the active pane type - can return null if no active pane type is set - * @since POI 5.2.3 + * @since 5.2.3 */ public PaneType getActivePaneType() { switch (activePane) { diff --git a/poi/src/main/java/org/apache/poi/ss/util/RegionUtil.java b/poi/src/main/java/org/apache/poi/ss/util/RegionUtil.java index b68fd8bb57..a729c5d1ab 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/RegionUtil.java +++ b/poi/src/main/java/org/apache/poi/ss/util/RegionUtil.java @@ -56,7 +56,7 @@ public final class RegionUtil { /** * @param property The property to set * @param value The value to set the property to - * @since POI 5.4.0 + * @since 5.4.0 */ public CellPropertySetter(CellPropertyType property, int value) { this.property = property; @@ -66,7 +66,7 @@ public final class RegionUtil { /** * @param property The property to set * @param value The value to set the property to - * @since POI 5.4.0 + * @since 5.4.0 */ public CellPropertySetter(CellPropertyType property, BorderStyle value) { this.property = property; @@ -87,7 +87,7 @@ public final class RegionUtil { * @param border The new border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.16 beta 1 + * @since 3.16 beta 1 */ public static void setBorderLeft(BorderStyle border, CellRangeAddress region, Sheet sheet) { int rowStart = region.getFirstRow(); @@ -107,7 +107,7 @@ public final class RegionUtil { * @param color The color of the border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.15 beta 2 + * @since 3.15 beta 2 */ public static void setLeftBorderColor(int color, CellRangeAddress region, Sheet sheet) { int rowStart = region.getFirstRow(); @@ -127,7 +127,7 @@ public final class RegionUtil { * @param border The new border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.16 beta 1 + * @since 3.16 beta 1 */ public static void setBorderRight(BorderStyle border, CellRangeAddress region, Sheet sheet) { int rowStart = region.getFirstRow(); @@ -147,7 +147,7 @@ public final class RegionUtil { * @param color The color of the border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.15 beta 2 + * @since 3.15 beta 2 */ public static void setRightBorderColor(int color, CellRangeAddress region, Sheet sheet) { int rowStart = region.getFirstRow(); @@ -167,7 +167,7 @@ public final class RegionUtil { * @param border The new border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.16 beta 1 + * @since 3.16 beta 1 */ public static void setBorderBottom(BorderStyle border, CellRangeAddress region, Sheet sheet) { int colStart = region.getFirstColumn(); @@ -187,7 +187,7 @@ public final class RegionUtil { * @param color The color of the border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.15 beta 2 + * @since 3.15 beta 2 */ public static void setBottomBorderColor(int color, CellRangeAddress region, Sheet sheet) { int colStart = region.getFirstColumn(); @@ -207,7 +207,7 @@ public final class RegionUtil { * @param border The new border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.16 beta 1 + * @since 3.16 beta 1 */ public static void setBorderTop(BorderStyle border, CellRangeAddress region, Sheet sheet) { int colStart = region.getFirstColumn(); @@ -227,7 +227,7 @@ public final class RegionUtil { * @param color The color of the border * @param region The region that should have the border * @param sheet The sheet that the region is on. - * @since POI 3.15 beta 2 + * @since 3.15 beta 2 */ public static void setTopBorderColor(int color, CellRangeAddress region, Sheet sheet) { int colStart = region.getFirstColumn(); diff --git a/poi/src/main/java/org/apache/poi/ss/util/SSCellRange.java b/poi/src/main/java/org/apache/poi/ss/util/SSCellRange.java index 20757c092f..ff62aeb84a 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/SSCellRange.java +++ b/poi/src/main/java/org/apache/poi/ss/util/SSCellRange.java @@ -122,7 +122,7 @@ public final class SSCellRange implements CellRange { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ @Override public Spliterator spliterator() { diff --git a/poi/src/main/java/org/apache/poi/ss/util/SheetUtil.java b/poi/src/main/java/org/apache/poi/ss/util/SheetUtil.java index 2a0e478cd9..fcc028be10 100644 --- a/poi/src/main/java/org/apache/poi/ss/util/SheetUtil.java +++ b/poi/src/main/java/org/apache/poi/ss/util/SheetUtil.java @@ -130,7 +130,7 @@ public class SheetUtil { * @param formatter formatter used to prepare the text to be measured * @param useMergedCells whether to use merged cells * @return the width in pixels or -1 if cell is empty - * @since POI 5.2.5 + * @since 5.2.5 */ public static double getCellWidth(Cell cell, float defaultCharWidth, DataFormatter formatter, boolean useMergedCells) { List mergedRegions = cell.getSheet().getMergedRegions(); @@ -172,7 +172,7 @@ public class SheetUtil { * @param useMergedCells whether to use merged cells * @param mergedRegions The list of merged regions as received via cell.getSheet().getMergedRegions() * @return the width in pixels or -1 if cell is empty - * @since POI 5.2.5 + * @since 5.2.5 */ public static double getCellWidth(Cell cell, float defaultCharWidth, DataFormatter formatter, boolean useMergedCells, List mergedRegions) { @@ -381,7 +381,7 @@ public class SheetUtil { * * @param wb the workbook to get the default character width from * @return default character width in pixels (as a float) - * @since POI 5.2.5 + * @since 5.2.5 */ @Internal public static float getDefaultCharWidthAsFloat(final Workbook wb) { @@ -407,7 +407,7 @@ public class SheetUtil { * @param the type of the fourth input to the function * @param the type of the fifth input to the function * @param the return type of the function - * @since POI 5.4.1 + * @since 5.4.1 */ @FunctionalInterface public interface Function5Arity { @@ -427,7 +427,7 @@ public class SheetUtil { *

* The default function will return the default character width. *

- * @since POI 5.4.1 + * @since 5.4.1 */ public static void setFailoverFunction(Function5Arity failoverFunction) { FAILOVER_FUNCTION = failoverFunction == null ? DEFAULT_FAILOVER_FUNCTION : failoverFunction; diff --git a/poi/src/main/java/org/apache/poi/util/CodepointsUtil.java b/poi/src/main/java/org/apache/poi/util/CodepointsUtil.java index 732af2e3ff..cd004ec327 100644 --- a/poi/src/main/java/org/apache/poi/util/CodepointsUtil.java +++ b/poi/src/main/java/org/apache/poi/util/CodepointsUtil.java @@ -46,7 +46,7 @@ public class CodepointsUtil { /** * @param text to iterate over * @return iterator with ints representing the codepoints - * @since POI 5.2.4 + * @since 5.2.4 */ public static PrimitiveIterator.OfInt primitiveIterator(String text) { return text.codePoints().iterator(); diff --git a/poi/src/main/java/org/apache/poi/util/ExceptionUtil.java b/poi/src/main/java/org/apache/poi/util/ExceptionUtil.java index f5c0e15e16..511efbd505 100644 --- a/poi/src/main/java/org/apache/poi/util/ExceptionUtil.java +++ b/poi/src/main/java/org/apache/poi/util/ExceptionUtil.java @@ -19,7 +19,7 @@ package org.apache.poi.util; /** * Utility methods for dealing with exceptions/throwables * - * @since POI 5.2.4 + * @since 5.2.4 */ public class ExceptionUtil { private ExceptionUtil() {} diff --git a/poi/src/main/java/org/apache/poi/util/IOUtils.java b/poi/src/main/java/org/apache/poi/util/IOUtils.java index 3487c00f96..9dc7ee80c5 100644 --- a/poi/src/main/java/org/apache/poi/util/IOUtils.java +++ b/poi/src/main/java/org/apache/poi/util/IOUtils.java @@ -71,7 +71,7 @@ public final class IOUtils { /** * @param maxOverride the max init size of ByteArrayOutputStream. * -1 (the default) means init size of ByteArrayOutputStream could be up to {@link Integer#MAX_VALUE} - * @since POI 5.2.2 + * @since 5.2.2 */ public static void setMaxByteArrayInitSize(final int maxOverride) { MAX_BYTE_ARRAY_INIT_SIZE = maxOverride; @@ -80,7 +80,7 @@ public final class IOUtils { /** * @return the max init size of ByteArrayOutputStream. * -1 (the default) means init size of ByteArrayOutputStream could be up to {@link Integer#MAX_VALUE} - * @since POI 5.2.2 + * @since 5.2.2 */ public static int getMaxByteArrayInitSize() { return MAX_BYTE_ARRAY_INIT_SIZE; @@ -229,7 +229,7 @@ public final class IOUtils { * @return A byte array with the read bytes. * @throws IOException If reading data fails or EOF is encountered too early for the given length. * @throws RecordFormatException If the requested length is invalid. - * @since POI 5.4.1 + * @since 5.4.1 */ public static byte[] toByteArray(InputStream stream, final long length, final int maxLength) throws IOException { return toByteArray(stream, @@ -248,7 +248,7 @@ public final class IOUtils { * @return A byte array with the read bytes. * @throws IOException If reading data fails or EOF is encountered too early for the given length. * @throws RecordFormatException If the requested length is invalid. - * @since POI 5.2.1 + * @since 5.2.1 */ public static byte[] toByteArrayWithMaxLength(InputStream stream, final int maxLength) throws IOException { return toByteArray(stream, maxLength, maxLength, false, false); @@ -626,7 +626,7 @@ public final class IOUtils { * @param name The name of the file to create. * @return The created file. * @throws IOException If path traversal is detected. - * @since POI 5.5.0 + * @since 5.5.0 */ public static File newFile(final File parent, final String name) throws IOException { final File file = new File(parent, name); diff --git a/poi/src/main/java/org/apache/poi/util/IntMapper.java b/poi/src/main/java/org/apache/poi/util/IntMapper.java index 3a2c4f2ecd..89099c09c9 100644 --- a/poi/src/main/java/org/apache/poi/util/IntMapper.java +++ b/poi/src/main/java/org/apache/poi/util/IntMapper.java @@ -92,7 +92,7 @@ public class IntMapper implements Duplicatable, Iterable { } /** - * @since POI 5.2.0 + * @since 5.2.0 */ public Spliterator spliterator() { return elements.spliterator(); diff --git a/poi/src/main/java/org/apache/poi/util/Internal.java b/poi/src/main/java/org/apache/poi/util/Internal.java index 76c93b8e61..dd16dc4f23 100644 --- a/poi/src/main/java/org/apache/poi/util/Internal.java +++ b/poi/src/main/java/org/apache/poi/util/Internal.java @@ -34,7 +34,7 @@ import java.lang.annotation.Documented; * not subject to the POI project policy of deprecating an element for 2 major * releases before removing. * - * @since POI-3.6 + * @since -3.6 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/poi/src/main/java/org/apache/poi/util/NotImplemented.java b/poi/src/main/java/org/apache/poi/util/NotImplemented.java index e815c5d153..7dd18d2d56 100644 --- a/poi/src/main/java/org/apache/poi/util/NotImplemented.java +++ b/poi/src/main/java/org/apache/poi/util/NotImplemented.java @@ -27,7 +27,7 @@ import java.lang.annotation.Documented; * Calling this method will result in a raised Exception * at runtime. * - * @since POI-3.14beta1 + * @since -3.14beta1 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/poi/src/main/java/org/apache/poi/util/Removal.java b/poi/src/main/java/org/apache/poi/util/Removal.java index f4c19441d6..1a3e5744a1 100644 --- a/poi/src/main/java/org/apache/poi/util/Removal.java +++ b/poi/src/main/java/org/apache/poi/util/Removal.java @@ -43,7 +43,7 @@ import java.lang.annotation.Documented; * the POI 3.17 release series, and may be deleted immediately after POI 3.16 is * released. This would be annotated {@code @Removal(version="3.17")}

. * - * @since POI-3.15 beta 3 + * @since -3.15 beta 3 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/poi/src/main/java/org/apache/poi/util/TempFile.java b/poi/src/main/java/org/apache/poi/util/TempFile.java index f5ab4e6f4a..a124d7d84d 100644 --- a/poi/src/main/java/org/apache/poi/util/TempFile.java +++ b/poi/src/main/java/org/apache/poi/util/TempFile.java @@ -62,7 +62,7 @@ public final class TempFile { * * @param strategy The new strategy to be used to create the temporary files for this thread. * null can be used to reset the strategy for this thread to the default one. - * @since POI 5.5.0 + * @since 5.5.0 */ public static void setThreadLocalTempFileCreationStrategy(TempFileCreationStrategy strategy) { if (strategy == null) { @@ -104,7 +104,7 @@ public final class TempFile { * @param task the task to be executed with the given temp file strategy * @return the result of the given task * - * @since POI 5.5.0 + * @since 5.5.0 */ public static R withStrategy(TempFileCreationStrategy newStrategy, Supplier task) { Objects.requireNonNull(newStrategy, "newStrategy"); diff --git a/poi/src/main/java/org/apache/poi/util/TempFileCreationStrategy.java b/poi/src/main/java/org/apache/poi/util/TempFileCreationStrategy.java index 30395dda35..0162f8dc45 100644 --- a/poi/src/main/java/org/apache/poi/util/TempFileCreationStrategy.java +++ b/poi/src/main/java/org/apache/poi/util/TempFileCreationStrategy.java @@ -82,7 +82,7 @@ public interface TempFileCreationStrategy { * * @throws IOException If no temporary directory could be created. * - * @since POI 3.15 beta 3. + * @since 3.15 beta 3. */ File createTempDirectory(String prefix) throws IOException; } diff --git a/poi/src/main/java/org/apache/poi/util/UserNameAwareTempFileCreationStrategy.java b/poi/src/main/java/org/apache/poi/util/UserNameAwareTempFileCreationStrategy.java index cb8fa00658..a9e5d2c0fe 100644 --- a/poi/src/main/java/org/apache/poi/util/UserNameAwareTempFileCreationStrategy.java +++ b/poi/src/main/java/org/apache/poi/util/UserNameAwareTempFileCreationStrategy.java @@ -25,7 +25,7 @@ import java.nio.file.Path; * that avoids permission issues when deploying applications with multiple users on the same server. * Other than adding the username to the temporary directory, all other behavior is the same as the superclass. * - * @since POI 5.4.0 + * @since 5.4.0 */ public class UserNameAwareTempFileCreationStrategy extends DefaultTempFileCreationStrategy { diff --git a/poi/src/main/java/org/apache/poi/wp/usermodel/HeaderFooterType.java b/poi/src/main/java/org/apache/poi/wp/usermodel/HeaderFooterType.java index bca6b6658d..0c65a55fb0 100644 --- a/poi/src/main/java/org/apache/poi/wp/usermodel/HeaderFooterType.java +++ b/poi/src/main/java/org/apache/poi/wp/usermodel/HeaderFooterType.java @@ -18,7 +18,7 @@ package org.apache.poi.wp.usermodel; /** - * @since POI v3.16 beta 1 + * @since v3.16 beta 1 */ public enum HeaderFooterType { diff --git a/poi/src/test/java/org/apache/poi/ss/util/BaseTestCellUtil.java b/poi/src/test/java/org/apache/poi/ss/util/BaseTestCellUtil.java index fb2200ba57..40102ce4db 100644 --- a/poi/src/test/java/org/apache/poi/ss/util/BaseTestCellUtil.java +++ b/poi/src/test/java/org/apache/poi/ss/util/BaseTestCellUtil.java @@ -569,7 +569,7 @@ public abstract class BaseTestCellUtil { /** * bug 55555 * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Test protected void setFillForegroundColorBeforeFillBackgroundColorEnumByEnum() throws IOException { @@ -591,7 +591,7 @@ public abstract class BaseTestCellUtil { /** * bug 55555 * - * @since POI 3.15 beta 3 + * @since 3.15 beta 3 */ @Test protected void setFillForegroundColorBeforeFillBackgroundColorEnum() throws IOException { @@ -613,7 +613,7 @@ public abstract class BaseTestCellUtil { /** * bug 63268 * - * @since POI 4.1.0 + * @since 4.1.0 */ @Test void setFontShouldNotCreateDuplicateStyle() throws IOException {