pashko/apache-poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2026-02-27 12:30:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

adjust 'since' values to remove POI

Browse Source
This commit is contained in:
PJ Fanning 2025-12-01 19:28:56 +01:00
parent 97cef0a3e3
commit f44ece137f
318 changed files with 716 additions and 716 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/HyperlinkRelationship.java
View File

@ -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 {
/**

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocument.java
View File

@ -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<PackagePart> getAllEmbeddedParts() throws OpenXML4JException;

12
poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java
View File

@ -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<ReferenceRelationship> getReferenceRelationships() {

4
poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLFactory.java
View File

@ -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 {

44
poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLProperties.java
View File

@ -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);
}

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/ReferenceRelationship.java
View File

@ -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;

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/extractor/POIXMLExtractorFactory.java
View File

@ -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();

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/util/NumberHelper.java
View File

@ -23,7 +23,7 @@ import org.apache.poi.util.Internal;
* Helper class for number related operations.
* <p>Note: This class is for internal POI usage only.</p>
*
* @since POI 5.5.0
* @since 5.5.0
*/
@Internal
public class NumberHelper {

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/util/PackageHelper.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/ooxml/util/XPathHelper.java
View File

@ -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

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCComplianceFlags.java
View File

@ -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 {

22
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/OPCPackage.java
View File

@ -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(

4
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/PackageRelationshipCollection.java
View File

@ -287,7 +287,7 @@ public final class PackageRelationshipCollection implements Iterable<PackageRela
/**
* Is this collection empty?
* @since POI 5.2.0
* @since 5.2.0
*/
public boolean isEmpty() {
return relationshipsByID.isEmpty();
@ -386,7 +386,7 @@ public final class PackageRelationshipCollection implements Iterable<PackageRela
/**
* Get this collection's spliterator.
*
* @since POI 5.2.0
* @since 5.2.0
*/
@Override
public Spliterator<PackageRelationship> spliterator() {

14
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/ZipPackage.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/EncryptedTempFilePackagePart.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/InvalidZipException.java
View File

@ -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) {

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/TempFilePackagePart.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/opc/internal/unmarshallers/PackagePropertiesUnmarshaller.java
View File

@ -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;

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipArchiveFakeEntry.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipEntrySource.java
View File

@ -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);

8
poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipInputStreamZipEntrySource.java
View File

@ -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;

8
poi-ooxml/src/main/java/org/apache/poi/openxml4j/util/ZipSecureFile.java
View File

@ -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;

30
poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java
View File

@ -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 <a href="https://santuario.apache.org/faq.html#faq-4.SecureValidation">XmlSec SecureValidation</a>
*
* @since POI 5.2.0
* @since 5.2.0
*/
public void setSecureValidation(boolean secureValidation) {
this.secureValidation = secureValidation;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/XDDFLineProperties.java
View File

@ -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();

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFArea3DChartData.java
View File

@ -151,7 +151,7 @@ public class XDDFArea3DChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTAreaSer getCTAreaSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFAreaChartData.java
View File

@ -127,7 +127,7 @@ public class XDDFAreaChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTAreaSer getCTAreaSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBar3DChartData.java
View File

@ -198,7 +198,7 @@ public class XDDFBar3DChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTBarSer getCTBarSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBarChartData.java
View File

@ -188,7 +188,7 @@ public class XDDFBarChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTBarSer getCTBarSer() {
return series;

4
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFBubbleChartData.java
View File

@ -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;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFCategoryAxis.java
View File

@ -81,7 +81,7 @@ public class XDDFCategoryAxis extends XDDFChartAxis {
}
/**
* @since POI 4.0.2
* @since 4.0.2
*/
@Override
public XDDFRunProperties getOrAddTextProperties() {

46
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChart.java
View File

@ -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()) {

6
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartAxis.java
View File

@ -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);

10
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFChartData.java
View File

@ -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<CTDPt> 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<CTDPt> points = getDPtList();

8
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDataSource.java
View File

@ -33,12 +33,12 @@ public interface XDDFDataSource<T> {
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<T> {
String getFormatCode();
/**
* @since POI 5.0.0
* @since 5.0.0
*/
@Internal
default void fillNumericalCache(CTNumData cache) {
@ -95,7 +95,7 @@ public interface XDDFDataSource<T> {
}
/**
* @since POI 4.1.2
* @since 4.1.2
*/
@Internal
default void fillStringCache(CTStrData cache) {

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDateAxis.java
View File

@ -85,7 +85,7 @@ public class XDDFDateAxis extends XDDFChartAxis {
}
/**
* @since POI 4.0.2
* @since 4.0.2
*/
@Override
public XDDFRunProperties getOrAddTextProperties() {

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFDoughnutChartData.java
View File

@ -138,7 +138,7 @@ public class XDDFDoughnutChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTPieSer getCTPieSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFErrorBars.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLine3DChartData.java
View File

@ -142,7 +142,7 @@ public class XDDFLine3DChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTLineSer getCTLineSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFLineChartData.java
View File

@ -117,7 +117,7 @@ public class XDDFLineChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTLineSer getCTLineSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPie3DChartData.java
View File

@ -87,7 +87,7 @@ public class XDDFPie3DChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTPieSer getCTPieSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFPieChartData.java
View File

@ -117,7 +117,7 @@ public class XDDFPieChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTPieSer getCTPieSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFRadarChartData.java
View File

@ -117,7 +117,7 @@ public class XDDFRadarChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTRadarSer getCTRadarSer() {
return series;

12
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFScatterChartData.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSeriesAxis.java
View File

@ -81,7 +81,7 @@ public class XDDFSeriesAxis extends XDDFChartAxis {
}
/**
* @since POI 4.0.2
* @since 4.0.2
*/
@Override
public XDDFRunProperties getOrAddTextProperties() {

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurface3DChartData.java
View File

@ -124,7 +124,7 @@ public class XDDFSurface3DChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTSurfaceSer getCTSurfaceSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFSurfaceChartData.java
View File

@ -129,7 +129,7 @@ public class XDDFSurfaceChartData extends XDDFChartData {
}
/**
* @since POI 5.2.3
* @since 5.2.3
*/
public CTSurfaceSer getCTSurfaceSer() {
return series;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFTitle.java
View File

@ -85,7 +85,7 @@ public class XDDFTitle {
}
/**
* @since POI 4.1.2
* @since 4.1.2
*/
public XDDFRunProperties getOrAddTextProperties() {
CTTextBody text;

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/chart/XDDFValueAxis.java
View File

@ -81,7 +81,7 @@ public class XDDFValueAxis extends XDDFChartAxis {
}
/**
* @since POI 4.0.2
* @since 4.0.2
*/
@Override
public XDDFRunProperties getOrAddTextProperties() {

2
poi-ooxml/src/main/java/org/apache/poi/xddf/usermodel/text/XDDFTextParagraph.java
View File

@ -122,7 +122,7 @@ public class XDDFTextParagraph implements Iterable<XDDFTextRun> {
}
/**
* @since POI 5.2.0
* @since 5.2.0
*/
@Override
public Spliterator<XDDFTextRun> spliterator() {

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFBaseContents.java
View File

@ -52,7 +52,7 @@ public class XDGFBaseContents extends XDGFXMLDocumentPart {
protected List<XDGFConnection> _connections = new ArrayList<>();
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
public XDGFBaseContents(PackagePart part) {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFFactory.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasterContents.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFMasters.java
View File

@ -48,7 +48,7 @@ public class XDGFMasters extends XDGFXMLDocumentPart {
protected Map<Long, XDGFMaster> _masters = new HashMap<>();
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
public XDGFMasters(PackagePart part) {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPageContents.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XDGFPages.java
View File

@ -47,7 +47,7 @@ public class XDGFPages extends XDGFXMLDocumentPart {
List<XDGFPage> _pages = new ArrayList<>();
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
public XDGFPages(PackagePart part) {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
View File

@ -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));

4
poi-ooxml/src/main/java/org/apache/poi/xdgf/xml/XDGFXMLDocumentPart.java
View File

@ -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) {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFParser.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/XSLFReadException.java
View File

@ -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.</p>
* @since POI 5.5.0
* @since 5.5.0
*/
public class XSLFReadException extends POIException {
private static final long serialVersionUID = 1L;

4
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
View File

@ -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);

4
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFChart.java
View File

@ -62,7 +62,7 @@ public final class XSLFChart extends XDDFChart {
*
* @param part the package part holding the chart data,
* the content type must be <code>application/vnd.openxmlformats-officedocument.drawingml.chart+xml</code>
* @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();

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComment.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFCommentAuthors.java
View File

@ -49,7 +49,7 @@ public class XSLFCommentAuthors extends POIXMLDocumentPart {
* @param part the package part holding the comment authors data,
* the content type must be <code>application/vnd.openxmlformats-officedocument.commentAuthors+xml</code>
*
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
XSLFCommentAuthors(PackagePart part) throws IOException, XmlException {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFComments.java
View File

@ -46,7 +46,7 @@ public class XSLFComments extends POIXMLDocumentPart {
*
* @param part the package part holding the comments data,
* the content type must be <code>application/vnd.openxmlformats-officedocument.comments+xml</code>
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
XSLFComments(PackagePart part) throws IOException, XmlException {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDiagram.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFDrawing.java
View File

@ -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();

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFactory.java
View File

@ -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) {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontData.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFFontInfo.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFGraphicFrame.java
View File

@ -194,7 +194,7 @@ public class XSLFGraphicFrame extends XSLFShape implements GraphicalFrame<XSLFSh
}
/**
* @since POI 5.2.0
* @since 5.2.0
*/
public boolean hasDiagram() {
String uri = getGraphicalData().getUri();

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotes.java
View File

@ -50,7 +50,7 @@ implements Notes<XSLFShape,XSLFTextParagraph> {
* @param part the package part holding the notes data,
* the content type must be <code>application/vnd.openxmlformats-officedocument.notes+xml</code>
*
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
XSLFNotes(PackagePart part) throws IOException, XmlException {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFNotesMaster.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFObjectData.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureData.java
View File

@ -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);

16
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
View File

@ -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();

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPlaceholderDetails.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFPropertiesDelegate.java
View File

@ -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 {

6
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSheet.java
View File

@ -93,7 +93,7 @@ implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph> {
}
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
protected XSLFSheet(PackagePart part) {
super(part);
@ -719,7 +719,7 @@ implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph> {
* 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<XSLFShape,XSLFTextParagraph> {
* 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);

6
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
View File

@ -73,7 +73,7 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
* @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<XSLFShape,XSLFTextParagraph> {
/**
* @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<XSLFShape,XSLFTextParagraph> {
/**
* @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() {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideLayout.java
View File

@ -39,7 +39,7 @@ implements MasterSheet<XSLFShape,XSLFTextParagraph> {
private XSLFSlideMaster _master;
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
public XSLFSlideLayout(PackagePart part) throws IOException, XmlException {
super(part);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlideMaster.java
View File

@ -58,7 +58,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.SldMasterDocument;
private Map<String, XSLFSlideLayout> _layouts;
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
protected XSLFSlideMaster(PackagePart part) throws IOException, XmlException {
super(part);

10
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTable.java
View File

@ -170,7 +170,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable<XSLFTableRow
/**
* Insert a new row at the given index.
* @param rowIdx the row index.
* @since POI 5.0.0
* @since 5.0.0
*/
public XSLFTableRow insertRow(int rowIdx) {
if (getNumberOfRows() < rowIdx) {
@ -200,7 +200,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable<XSLFTableRow
/**
* Add a new column at the end of the table.
* @since POI 4.1.2
* @since 4.1.2
*/
public void addColumn() {
long width = POIXMLUnits.parseLength(_table.getTblGrid().getGridColArray(getNumberOfColumns() - 1).xgetW());
@ -215,7 +215,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable<XSLFTableRow
/**
* Insert a new column at the given index.
* @param colIdx the column index.
* @since POI 4.1.2
* @since 4.1.2
*/
public void insertColumn(int colIdx) {
if (getNumberOfColumns() < colIdx) {
@ -233,7 +233,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable<XSLFTableRow
/**
* Remove the column at the given index.
* @param colIdx the column index.
* @since POI 4.1.2
* @since 4.1.2
*/
public void removeColumn(int colIdx) {
if (getNumberOfColumns() < colIdx) {
@ -329,7 +329,7 @@ public class XSLFTable extends XSLFGraphicFrame implements Iterable<XSLFTableRow
*
* @return the assigned TableStyle
*
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
protected XSLFTableStyle getTableStyle() {
CTTable tab = getCTTable();

16
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableCell.java
View File

@ -573,7 +573,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
public void setTextDirection(TextDirection orientation) {
@ -605,7 +605,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
public TextDirection getTextDirection() {
@ -663,7 +663,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
* temporarily store the location of the cell for a later retrieval, e.g.
* for rendering
*
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
public void setAnchor(Rectangle2D anchor) {
@ -675,7 +675,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
public Rectangle2D getAnchor() {
@ -688,7 +688,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
public boolean isMerged() {
@ -697,7 +697,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
@Override
protected XSLFCellTextParagraph newTextParagraph(CTTextParagraph p) {
@ -710,7 +710,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
private final class XSLFCellTextParagraph extends XSLFTextParagraph {
private XSLFCellTextParagraph(CTTextParagraph p, XSLFTextShape shape) {
@ -724,7 +724,7 @@ public class XSLFTableCell extends XSLFTextShape implements TableCell<XSLFShape,
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
private final class XSLFCellTextRun extends XSLFTextRun {
private XSLFCellTextRun(XmlObject r, XSLFTextParagraph p) {

4
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableRow.java
View File

@ -84,7 +84,7 @@ public class XSLFTableRow implements Iterable<XSLFTableCell> {
/**
* 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<XSLFTableCell> {
/**
* 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) {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyle.java
View File

@ -49,7 +49,7 @@ public class XSLFTableStyle {
}
/**
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
protected CTTablePartStyle getTablePartStyle(TablePartStyle tps) {
switch (tps) {

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTableStyles.java
View File

@ -41,7 +41,7 @@ public class XSLFTableStyles extends POIXMLDocumentPart implements Iterable<XSLF
}
/**
* @since POI 3.14-Beta1
* @since 3.14-Beta1
*/
public XSLFTableStyles(PackagePart part) throws IOException, XmlException {
super(part);

6
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java
View File

@ -50,7 +50,7 @@ import static org.apache.poi.xssf.usermodel.XSSFRelation.NS_PRESENTATIONML;
* Represents a paragraph of text within the containing text body.
* The paragraph is the highest level text separation mechanism.
*
* @since POI-3.8
* @since -3.8
*/
@Beta
public class XSLFTextParagraph implements TextParagraph<XSLFShape,XSLFTextParagraph,XSLFTextRun> {
@ -130,7 +130,7 @@ public class XSLFTextParagraph implements TextParagraph<XSLFShape,XSLFTextParagr
*
* @param textRun a run of text
* @return whether the run was removed
* @since POI 5.2.2
* @since 5.2.2
*/
public boolean removeTextRun(XSLFTextRun textRun) {
if (_runs.remove(textRun)) {
@ -1057,7 +1057,7 @@ public class XSLFTextParagraph implements TextParagraph<XSLFShape,XSLFTextParagr
*
* @return a new text paragraph
*
* @since POI 3.15-beta2
* @since 3.15-beta2
*/
protected XSLFTextRun newTextRun(XmlObject r) {
return new XSLFTextRun(r, this);

6
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
View File

@ -170,7 +170,7 @@ public class XSLFTextRun implements TextRun, 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
*/
@Override
public PaintStyle getHighlightColor() {
@ -200,7 +200,7 @@ public class XSLFTextRun implements TextRun, 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
*/
@Override
public void setHighlightColor(final Color color) {
@ -214,7 +214,7 @@ public class XSLFTextRun implements TextRun, HighlightColorSupport {
* @throws IllegalArgumentException If the supplied paint style is not null or a SolidPaint.
*
* @see org.apache.poi.sl.draw.DrawPaint#createSolidPaint(Color)
* @since POI 5.2.4
* @since 5.2.4
*/
@Override
public void setHighlightColor(final PaintStyle color) {

6
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTextShape.java
View File

@ -90,7 +90,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape
}
/**
* @since POI 5.2.0
* @since 5.2.0
*/
@Override
public Spliterator<XSLFTextParagraph> 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);

2
poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFTheme.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFParser.java
View File

@ -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 {

2
poi-ooxml/src/main/java/org/apache/poi/xssf/XSSFReadException.java
View File

@ -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.</p>
* @since POI 5.5.0
* @since 5.5.0
*/
public class XSSFReadException extends POIException {
private static final long serialVersionUID = 1L;

4
poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java
View File

@ -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 {
/**

10
poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.java
View File

@ -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 <code>true</code> 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 {

2
poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFBReader.java
View File

@ -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 {

6
poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
View File

@ -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);

2
poi-ooxml/src/main/java/org/apache/poi/xssf/model/CalculationChain.java
View File

@ -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);

8
poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
View File

@ -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);

8
poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
View File

@ -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) {

2
poi-ooxml/src/main/java/org/apache/poi/xssf/model/ExternalLinksTable.java
View File

@ -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);

Some files were not shown because too many files have changed in this diff Show More