adjust 'since' values to remove POI

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

View File

@ -23,7 +23,7 @@ import java.net.URI;
/** /**
* Represents a hyperlink relationship. * Represents a hyperlink relationship.
* *
* @since POI 5.3.0 * @since 5.3.0
*/ */
public class HyperlinkRelationship extends ReferenceRelationship { public class HyperlinkRelationship extends ReferenceRelationship {
/** /**

View File

@ -155,7 +155,7 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close
* @return the document's embedded files * @return the document's embedded files
* *
* @throws OpenXML4JException if the embedded parts can't be determined * @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; public abstract List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException;

View File

@ -167,7 +167,7 @@ public class POIXMLDocumentPart {
* *
* @param part - The package part that holds xml data representing this sheet. * @param part - The package part that holds xml data representing this sheet.
* @see #read(POIXMLFactory, Map) * @see #read(POIXMLFactory, Map)
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public POIXMLDocumentPart(PackagePart part) { public POIXMLDocumentPart(PackagePart part) {
this(null, part); this(null, part);
@ -180,7 +180,7 @@ public class POIXMLDocumentPart {
* @param parent - Parent part * @param parent - Parent part
* @param part - The package part that holds xml data representing this sheet. * @param part - The package part that holds xml data representing this sheet.
* @see #read(POIXMLFactory, Map) * @see #read(POIXMLFactory, Map)
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part) { public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part) {
this.packagePart = part; this.packagePart = part;
@ -749,7 +749,7 @@ public class POIXMLDocumentPart {
* *
* @param relId the part which is to be removed * @param relId the part which is to be removed
* @return true, if the relation was removed * @return true, if the relation was removed
* @since POI 5.3.0 * @since 5.3.0
*/ */
public final boolean removeReferenceRelationship(String relId) { public final boolean removeReferenceRelationship(String relId) {
ReferenceRelationship existing = referenceRelationships.remove(relId); ReferenceRelationship existing = referenceRelationships.remove(relId);
@ -766,7 +766,7 @@ public class POIXMLDocumentPart {
* *
* @param relId the relation id * @param relId the relation id
* @return the reference relationship or {@code null} if not found * @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) { public final ReferenceRelationship getReferenceRelationship(String relId) {
return referenceRelationships.get(relId); return referenceRelationships.get(relId);
@ -779,7 +779,7 @@ public class POIXMLDocumentPart {
* @param isExternal true, if the target is an external resource * @param isExternal true, if the target is an external resource
* @param relId the relation id * @param relId the relation id
* @return the created reference relationship * @return the created reference relationship
* @since POI 5.3.0 * @since 5.3.0
*/ */
public final HyperlinkRelationship createHyperlink(URI uri, boolean isExternal, String relId) { public final HyperlinkRelationship createHyperlink(URI uri, boolean isExternal, String relId) {
PackageRelationship pr = packagePart.addRelationship(uri, isExternal ? TargetMode.EXTERNAL : TargetMode.INTERNAL, 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. * Returns an unmodifiable list of reference relationships for this POIXMLDocumentPart.
* *
* @return reference relationships * @return reference relationships
* @since POI 5.3.0 * @since 5.3.0
* @see #getRelationParts() for child relations * @see #getRelationParts() for child relations
*/ */
public final List<ReferenceRelationship> getReferenceRelationships() { public final List<ReferenceRelationship> getReferenceRelationships() {

View File

@ -75,7 +75,7 @@ public abstract class POIXMLFactory {
* @param relationshipType the relationship type of the descriptor * @param relationshipType the relationship type of the descriptor
* @return the descriptor or null if type is unknown * @return the descriptor or null if type is unknown
* *
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
protected abstract POIXMLRelation getDescriptor(String relationshipType); 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 * @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) { protected PackageRelationship getPackageRelationship(POIXMLDocumentPart parent, PackagePart part) {
try { try {

View File

@ -316,11 +316,11 @@ public class POIXMLProperties {
public void setLastPrinted(String date) throws InvalidFormatException { public void setLastPrinted(String date) throws InvalidFormatException {
part.setLastPrintedProperty(date); part.setLastPrintedProperty(date);
} }
/** @since POI 3.15 beta 3 */ /** @since 3.15 beta 3 */
public String getLastModifiedByUser() { public String getLastModifiedByUser() {
return part.getLastModifiedByProperty().orElse(null); return part.getLastModifiedByProperty().orElse(null);
} }
/** @since POI 3.15 beta 3 */ /** @since 3.15 beta 3 */
public void setLastModifiedByUser(String user) { public void setLastModifiedByUser(String user) {
part.setLastModifiedByProperty(user); part.setLastModifiedByProperty(user);
} }
@ -349,7 +349,7 @@ public class POIXMLProperties {
/** /**
* Sets the version property. * Sets the version property.
* @param version property value * @param version property value
* @since POI 5.2.3 * @since 5.2.3
*/ */
public void setVersion(String version) { public void setVersion(String version) {
part.setVersionProperty(version); part.setVersionProperty(version);
@ -358,7 +358,7 @@ public class POIXMLProperties {
/** /**
* Returns the version property value. * Returns the version property value.
* @return version property (can be null) * @return version property (can be null)
* @since POI 5.2.3 * @since 5.2.3
*/ */
public String getVersion() { public String getVersion() {
return part.getVersionProperty().orElse(null); return part.getVersionProperty().orElse(null);
@ -399,7 +399,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setTemplate(String template) { public void setTemplate(String template) {
props.getProperties().setTemplate(template); props.getProperties().setTemplate(template);
} }
@ -409,7 +409,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setManager(String manager) { public void setManager(String manager) {
props.getProperties().setManager(manager); props.getProperties().setManager(manager);
} }
@ -419,7 +419,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setCompany(String company) { public void setCompany(String company) {
props.getProperties().setCompany(company); props.getProperties().setCompany(company);
} }
@ -429,7 +429,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setPresentationFormat(String presentationFormat) { public void setPresentationFormat(String presentationFormat) {
props.getProperties().setPresentationFormat(presentationFormat); props.getProperties().setPresentationFormat(presentationFormat);
} }
@ -439,7 +439,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setApplication(String application) { public void setApplication(String application) {
props.getProperties().setApplication(application); props.getProperties().setApplication(application);
} }
@ -449,7 +449,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setAppVersion(String appVersion) { public void setAppVersion(String appVersion) {
props.getProperties().setAppVersion(appVersion); props.getProperties().setAppVersion(appVersion);
} }
@ -460,7 +460,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setPages(int pages) { public void setPages(int pages) {
props.getProperties().setPages(pages); props.getProperties().setPages(pages);
} }
@ -470,7 +470,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setWords(int words) { public void setWords(int words) {
props.getProperties().setWords(words); props.getProperties().setWords(words);
} }
@ -480,7 +480,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setCharacters(int characters) { public void setCharacters(int characters) {
props.getProperties().setCharacters(characters); props.getProperties().setCharacters(characters);
} }
@ -490,7 +490,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setCharactersWithSpaces(int charactersWithSpaces) { public void setCharactersWithSpaces(int charactersWithSpaces) {
props.getProperties().setCharactersWithSpaces(charactersWithSpaces); props.getProperties().setCharactersWithSpaces(charactersWithSpaces);
} }
@ -500,7 +500,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setLines(int lines) { public void setLines(int lines) {
props.getProperties().setLines(lines); props.getProperties().setLines(lines);
} }
@ -510,7 +510,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setParagraphs(int paragraphs) { public void setParagraphs(int paragraphs) {
props.getProperties().setParagraphs(paragraphs); props.getProperties().setParagraphs(paragraphs);
} }
@ -520,7 +520,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setSlides(int slides) { public void setSlides(int slides) {
props.getProperties().setSlides(slides); props.getProperties().setSlides(slides);
} }
@ -530,7 +530,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setNotes(int notes) { public void setNotes(int notes) {
props.getProperties().setNotes(notes); props.getProperties().setNotes(notes);
} }
@ -540,7 +540,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setTotalTime(int totalTime) { public void setTotalTime(int totalTime) {
props.getProperties().setTotalTime(totalTime); props.getProperties().setTotalTime(totalTime);
} }
@ -550,7 +550,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setHiddenSlides(int hiddenSlides) { public void setHiddenSlides(int hiddenSlides) {
props.getProperties().setHiddenSlides(hiddenSlides); props.getProperties().setHiddenSlides(hiddenSlides);
} }
@ -560,7 +560,7 @@ public class POIXMLProperties {
} }
return -1; return -1;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setMMClips(int mmClips) { public void setMMClips(int mmClips) {
props.getProperties().setMMClips(mmClips); props.getProperties().setMMClips(mmClips);
} }
@ -571,7 +571,7 @@ public class POIXMLProperties {
} }
return null; return null;
} }
/** @since POI 4.1.1 */ /** @since 4.1.1 */
public void setHyperlinkBase(String hyperlinkBase) { public void setHyperlinkBase(String hyperlinkBase) {
props.getProperties().setHyperlinkBase(hyperlinkBase); props.getProperties().setHyperlinkBase(hyperlinkBase);
} }

View File

@ -24,7 +24,7 @@ import java.net.URI;
/** /**
* Defines a reference relationship. A reference relationship can be internal or external. * 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 { public abstract class ReferenceRelationship {
private POIXMLDocumentPart container; private POIXMLDocumentPart container;

View File

@ -119,7 +119,7 @@ public final class POIXMLExtractorFactory implements ExtractorProvider {
* Clears the setting for this thread made by {@link #setThreadPrefersEventExtractors(boolean) } * Clears the setting for this thread made by {@link #setThreadPrefersEventExtractors(boolean) }
* *
* @see #setThreadPrefersEventExtractors(boolean) * @see #setThreadPrefersEventExtractors(boolean)
* @since POI 5.2.4 * @since 5.2.4
*/ */
public static void removeThreadPrefersEventExtractorsSetting() { public static void removeThreadPrefersEventExtractorsSetting() {
ExtractorFactory.removeThreadPrefersEventExtractorsSetting(); ExtractorFactory.removeThreadPrefersEventExtractorsSetting();

View File

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

View File

@ -58,7 +58,7 @@ public final class PackageHelper {
* @return OPCPackage * @return OPCPackage
* @throws IOException If reading data from the stream fails * @throws IOException If reading data from the stream fails
* @throws POIXMLException If the stream is not a valid OPC package * @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 { public static OPCPackage open(InputStream stream, boolean closeStream) throws IOException {
try { try {

View File

@ -102,7 +102,7 @@ public final class XPathHelper {
* thrown if the AlternateContent is not allowed by the surrounding element or if the * thrown if the AlternateContent is not allowed by the surrounding element or if the
* extracted object is of the generic type XmlAnyTypeImpl. * extracted object is of the generic type XmlAnyTypeImpl.
* *
* @since POI 4.1.2 * @since 4.1.2
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Internal @Internal

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 * Consumers may disable these compliance checks individually or as a whole at their
* own discretion to allow certain non-compliant documents to be parsed. * own discretion to allow certain non-compliant documents to be parsed.
* @since POI 5.4.1 * @since 5.4.1
*/ */
public class OPCComplianceFlags { public class OPCComplianceFlags {

View File

@ -151,7 +151,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @param opcComplianceFlags Enable or disable specific OPC compliance flags. * @param opcComplianceFlags Enable or disable specific OPC compliance flags.
* This is useful to allow parsing of certain non-compliant documents. * This is useful to allow parsing of certain non-compliant documents.
* @throws OpenXML4JRuntimeException if there are issues creating properties part * @throws OpenXML4JRuntimeException if there are issues creating properties part
* @since POI 5.4.1 * @since 5.4.1
*/ */
OPCPackage(PackageAccess access, OPCComplianceFlags opcComplianceFlags) { OPCPackage(PackageAccess access, OPCComplianceFlags opcComplianceFlags) {
if (getClass() != ZipPackage.class) { if (getClass() != ZipPackage.class) {
@ -203,7 +203,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @throws InvalidFormatException * @throws InvalidFormatException
* If the specified file doesn't exist, and a parsing error * If the specified file doesn't exist, and a parsing error
* occur. * occur.
* @since POI 5.4.1 * @since 5.4.1
*/ */
public static OPCPackage open(String path, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { public static OPCPackage open(String path, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException {
return open(path, defaultPackageAccess, opcComplianceFlags); return open(path, defaultPackageAccess, opcComplianceFlags);
@ -234,7 +234,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @throws InvalidFormatException * @throws InvalidFormatException
* If the specified file doesn't exist, and a parsing error * If the specified file doesn't exist, and a parsing error
* occur. * occur.
* @since POI 5.4.1 * @since 5.4.1
*/ */
public static OPCPackage open(File file, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException { public static OPCPackage open(File file, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException {
return open(file, defaultPackageAccess, opcComplianceFlags); 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 * The level of OPC compliance to enforce when reading the package
* @return A Package object * @return A Package object
* @throws InvalidFormatException if a parsing error occur. * @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 { public static OPCPackage open(ZipEntrySource zipEntry, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException {
OPCPackage pack = new ZipPackage(zipEntry, PackageAccess.READ, opcComplianceFlags); OPCPackage pack = new ZipPackage(zipEntry, PackageAccess.READ, opcComplianceFlags);
@ -317,7 +317,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* occur. * occur.
* @throws InvalidOperationException If the zip file cannot be opened. * @throws InvalidOperationException If the zip file cannot be opened.
* @throws InvalidFormatException if the package is not valid. * @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) public static OPCPackage open(String path, PackageAccess access, OPCComplianceFlags opcComplianceFlags)
throws InvalidFormatException, InvalidOperationException { 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. * If the specified file doesn't exist or is a directory.
* @throws InvalidFormatException * @throws InvalidFormatException
* If a parsing error occurs. * If a parsing error occurs.
* @since POI 5.4.1 * @since 5.4.1
*/ */
public static OPCPackage open(File file, PackageAccess access, OPCComplianceFlags opcComplianceFlags) public static OPCPackage open(File file, PackageAccess access, OPCComplianceFlags opcComplianceFlags)
throws InvalidFormatException { throws InvalidFormatException {
@ -447,7 +447,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @throws InvalidFormatException * @throws InvalidFormatException
* Throws if the specified file exist and is not valid. * Throws if the specified file exist and is not valid.
* @throws IOException If reading the stream fails * @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, public static OPCPackage open(InputStream in, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException,
IOException { IOException {
@ -484,7 +484,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @throws InvalidFormatException * @throws InvalidFormatException
* Throws if the specified file exist and is not valid. * Throws if the specified file exist and is not valid.
* @throws IOException If reading the stream fails * @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, public static OPCPackage open(InputStream in, boolean closeStream) throws InvalidFormatException,
IOException { IOException {
@ -509,7 +509,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @throws InvalidFormatException * @throws InvalidFormatException
* Throws if the specified file exist and is not valid. * Throws if the specified file exist and is not valid.
* @throws IOException If reading the stream fails * @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, public static OPCPackage open(InputStream in, boolean closeStream, OPCComplianceFlags opcComplianceFlags) throws InvalidFormatException,
IOException { IOException {
@ -1796,7 +1796,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @param oldContentType the content type to be replaced * @param oldContentType the content type to be replaced
* @param newContentType the replacement * @param newContentType the replacement
* @return whether replacement was successful * @return whether replacement was successful
* @since POI-3.8 * @since -3.8
*/ */
public boolean replaceContentType(String oldContentType, String newContentType){ public boolean replaceContentType(String oldContentType, String newContentType){
boolean success = false; boolean success = false;
@ -1861,7 +1861,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
/** /**
* @return true if the package is in Strict OOXML format * @return true if the package is in Strict OOXML format
* @since POI 5.1.0 * @since 5.1.0
*/ */
public boolean isStrictOoxmlFormat() { public boolean isStrictOoxmlFormat() {
PackageRelationshipCollection coreDocRelationships = getRelationshipsByType( PackageRelationshipCollection coreDocRelationships = getRelationshipsByType(

View File

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

View File

@ -110,7 +110,7 @@ public final class ZipPackage extends OPCPackage {
* Constructor. Creates a new, empty ZipPackage. * Constructor. Creates a new, empty ZipPackage.
* @param opcComplianceFlags * @param opcComplianceFlags
* The level of OPC compliance to enforce when reading the package * The level of OPC compliance to enforce when reading the package
* @since POI 5.4.1 * @since 5.4.1
*/ */
public ZipPackage(OPCComplianceFlags opcComplianceFlags) { public ZipPackage(OPCComplianceFlags opcComplianceFlags) {
super(defaultPackageAccess, opcComplianceFlags); super(defaultPackageAccess, opcComplianceFlags);
@ -156,7 +156,7 @@ public final class ZipPackage extends OPCPackage {
* ZipInputStream. * ZipInputStream.
* @throws IOException * @throws IOException
* if input stream cannot be opened, read, or closed * 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 { ZipPackage(InputStream in, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws IOException {
super(access, opcComplianceFlags); super(access, opcComplianceFlags);
@ -180,7 +180,7 @@ public final class ZipPackage extends OPCPackage {
* ZipInputStream. * ZipInputStream.
* @throws IOException * @throws IOException
* if input stream cannot be opened, read, or closed * 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 { ZipPackage(InputStream in, PackageAccess access, boolean closeStream) throws IOException {
this(in, access, closeStream, OPCComplianceFlags.enforceAll()); this(in, access, closeStream, OPCComplianceFlags.enforceAll());
@ -203,7 +203,7 @@ public final class ZipPackage extends OPCPackage {
* ZipInputStream. * ZipInputStream.
* @throws IOException * @throws IOException
* if input stream cannot be opened, read, or closed * 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 { ZipPackage(InputStream in, PackageAccess access, boolean closeStream, OPCComplianceFlags opcComplianceFlags) throws IOException {
super(access, opcComplianceFlags); super(access, opcComplianceFlags);
@ -235,7 +235,7 @@ public final class ZipPackage extends OPCPackage {
* @param opcComplianceFlags * @param opcComplianceFlags
* The level of OPC compliance to enforce when reading the package * The level of OPC compliance to enforce when reading the package
* @throws InvalidOperationException If the zip file cannot be opened. * @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 { ZipPackage(String path, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidOperationException {
this(new File(path), access, opcComplianceFlags); this(new File(path), access, opcComplianceFlags);
@ -264,7 +264,7 @@ public final class ZipPackage extends OPCPackage {
* @param opcComplianceFlags * @param opcComplianceFlags
* The level of OPC compliance to enforce when reading the package * The level of OPC compliance to enforce when reading the package
* @throws InvalidOperationException If the zip file cannot be opened. * @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 { ZipPackage(File file, PackageAccess access, OPCComplianceFlags opcComplianceFlags) throws InvalidOperationException {
super(access, opcComplianceFlags); super(access, opcComplianceFlags);
@ -348,7 +348,7 @@ public final class ZipPackage extends OPCPackage {
* The package access mode. * The package access mode.
* @param access * @param access
* The package access mode. * The package access mode.
* @since POI 5.4.1 * @since 5.4.1
*/ */
ZipPackage(ZipEntrySource zipEntry, PackageAccess access, OPCComplianceFlags opcComplianceFlags) { ZipPackage(ZipEntrySource zipEntry, PackageAccess access, OPCComplianceFlags opcComplianceFlags) {
super(access, opcComplianceFlags); super(access, opcComplianceFlags);

View File

@ -34,7 +34,7 @@ import java.io.*;
/** /**
* (Experimental) Encrypted Temp File version of a package part. * (Experimental) Encrypted Temp File version of a package part.
* *
* @since POI 5.1.0 * @since 5.1.0
*/ */
@Beta @Beta
public final class EncryptedTempFilePackagePart extends PackagePart { public final class EncryptedTempFilePackagePart extends PackagePart {

View File

@ -22,7 +22,7 @@ import java.io.IOException;
/** /**
* Thrown if the zip file is invalid. * Thrown if the zip file is invalid.
* *
* @since POI 5.4.0 * @since 5.4.0
*/ */
public class InvalidZipException extends IOException { public class InvalidZipException extends IOException {
public InvalidZipException(String message) { public InvalidZipException(String message) {

View File

@ -35,7 +35,7 @@ import java.nio.file.Files;
/** /**
* (Experimental) Temp File version of a package part. * (Experimental) Temp File version of a package part.
* *
* @since POI 5.1.0 * @since 5.1.0
*/ */
@Beta @Beta
public final class TempFilePackagePart extends PackagePart { public final class TempFilePackagePart extends PackagePart {

View File

@ -56,7 +56,7 @@ public final class PackagePropertiesUnmarshaller implements PartUnmarshaller {
/** /**
* @param opcComplianceFlags Overrides the default OPC compliance settings * @param opcComplianceFlags Overrides the default OPC compliance settings
* @since POI 5.4.1 * @since 5.4.1
*/ */
public PackagePropertiesUnmarshaller(OPCComplianceFlags opcComplianceFlags) { public PackagePropertiesUnmarshaller(OPCComplianceFlags opcComplianceFlags) {
this.opcComplianceFlags = opcComplianceFlags; this.opcComplianceFlags = opcComplianceFlags;

View File

@ -124,7 +124,7 @@ public final class ZipArchiveFakeEntry extends ZipArchiveEntry implements Closea
/** /**
* Deletes any temp files and releases any byte arrays. * Deletes any temp files and releases any byte arrays.
* @throws IOException If closing the entry fails. * @throws IOException If closing the entry fails.
* @since POI 5.1.0 * @since 5.1.0
*/ */
@Override @Override
public void close() throws IOException { public void close() throws IOException {

View File

@ -41,7 +41,7 @@ public interface ZipEntrySource extends Closeable {
* @param path the path in unix-notation * @param path the path in unix-notation
* @return the entry or {@code null} if not found * @return the entry or {@code null} if not found
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
ZipArchiveEntry getEntry(String path); ZipArchiveEntry getEntry(String path);

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 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 * 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) * 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) * @see #setEncryptTempFiles(boolean)
*/ */
public static void setThresholdBytesForTempFiles(int thresholdBytes) { 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 * 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) * and the data is put in a temp file instead (defaults to -1 meaning temp files are not used)
* @return threshold in bytes * @return threshold in bytes
* @since POI 5.1.0 * @since 5.1.0
*/ */
public static int getThresholdBytesForTempFiles() { public static int getThresholdBytesForTempFiles() {
return thresholdForTempFiles; 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. * Encrypt temp files when they are used. Only affects temp files related to zip entries.
* @param encrypt whether temp files should be encrypted * @param encrypt whether temp files should be encrypted
* @since POI 5.1.0 * @since 5.1.0
* @see #setThresholdBytesForTempFiles(int) * @see #setThresholdBytesForTempFiles(int)
*/ */
public static void setEncryptTempFiles(boolean encrypt) { 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. * 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() { public static boolean shouldEncryptTempFiles() {
return encryptTempFiles; return encryptTempFiles;

View File

@ -93,7 +93,7 @@ public class ZipSecureFile extends ZipFile {
* See setMaxFileCount() for details. * 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.). * @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() { public static long getMaxFileCount() {
return MAX_FILE_COUNT; 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. * including OOXML files like xlsx, docx, pptx, etc. The default is 1000.
* *
* @param maxFileCount The max accepted file count * @param maxFileCount The max accepted file count
* @since POI 5.2.4 * @since 5.2.4
*/ */
public static void setMaxFileCount(final long maxFileCount) { public static void setMaxFileCount(final long maxFileCount) {
MAX_FILE_COUNT = 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 * @param graceEntrySize the grace entry size of a single zip entry
* @throws IllegalArgumentException for negative graceEntrySize * @throws IllegalArgumentException for negative graceEntrySize
* @since POI 5.2.4 * @since 5.2.4
*/ */
public static void setGraceEntrySize(long graceEntrySize) { public static void setGraceEntrySize(long graceEntrySize) {
if (graceEntrySize < 0) { if (graceEntrySize < 0) {
@ -167,7 +167,7 @@ public class ZipSecureFile extends ZipFile {
* See setGraceEntrySize() for details. * See setGraceEntrySize() for details.
* *
* @return The current grace entry size * @return The current grace entry size
* @since POI 5.2.4 * @since 5.2.4
*/ */
public static long getGraceEntrySize() { public static long getGraceEntrySize() {
return GRACE_ENTRY_SIZE; return GRACE_ENTRY_SIZE;

View File

@ -232,14 +232,14 @@ public class SignatureConfig {
/** /**
* if true, the signature is added to the existing signatures * if true, the signature is added to the existing signatures
* *
* @since POI 4.1.0 * @since 4.1.0
*/ */
private boolean allowMultipleSignatures = false; private boolean allowMultipleSignatures = false;
/** /**
* Switch to enable/disable secure validation - see setter for more information * Switch to enable/disable secure validation - see setter for more information
* *
* @since POI 5.2.0 * @since 5.2.0
*/ */
private boolean secureValidation = true; 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 * Switch to enable/disable automatic CRL download - by default the download is with all https hostname
* and certificate verifications disabled. * and certificate verifications disabled.
* *
* @since POI 5.2.1 * @since 5.2.1
*/ */
private boolean allowCRLDownload = false; private boolean allowCRLDownload = false;
@ -358,7 +358,7 @@ public class SignatureConfig {
/** /**
* @return the formatted execution time ({@link #SIGNATURE_TIME_FORMAT}) * @return the formatted execution time ({@link #SIGNATURE_TIME_FORMAT})
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public String formatExecutionTime() { public String formatExecutionTime() {
final DateFormat fmt = new SimpleDateFormat(SIGNATURE_TIME_FORMAT, Locale.ROOT); 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}) * Sets the executionTime which is in standard format ({@link #SIGNATURE_TIME_FORMAT})
* @param executionTime the execution time * @param executionTime the execution time
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setExecutionTime(String executionTime) { public void setExecutionTime(String executionTime) {
if (executionTime != null && !executionTime.isEmpty()){ if (executionTime != null && !executionTime.isEmpty()){
@ -572,7 +572,7 @@ public class SignatureConfig {
/** /**
* @return the http client used for timestamp server connections * @return the http client used for timestamp server connections
* *
* @since POI 5.2.1 * @since 5.2.1
*/ */
public TimeStampHttpClient getTspHttpClient() { public TimeStampHttpClient getTspHttpClient() {
return tspHttpClient; return tspHttpClient;
@ -581,7 +581,7 @@ public class SignatureConfig {
/** /**
* @param tspHttpClient the http client used for timestamp server connections * @param tspHttpClient the http client used for timestamp server connections
* *
* @since POI 5.2.1 * @since 5.2.1
*/ */
public void setTspHttpClient(TimeStampHttpClient tspHttpClient) { public void setTspHttpClient(TimeStampHttpClient tspHttpClient) {
this.tspHttpClient = tspHttpClient; this.tspHttpClient = tspHttpClient;
@ -664,7 +664,7 @@ public class SignatureConfig {
* @param xadesDigestAlgo hash algorithm used for XAdES. * @param xadesDigestAlgo hash algorithm used for XAdES.
* When {@code null}, defaults to {@link #getDigestAlgo()} * When {@code null}, defaults to {@link #getDigestAlgo()}
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setXadesDigestAlgo(String xadesDigestAlgo) { public void setXadesDigestAlgo(String xadesDigestAlgo) {
this.xadesDigestAlgo = getDigestMethodAlgo(xadesDigestAlgo); this.xadesDigestAlgo = getDigestMethodAlgo(xadesDigestAlgo);
@ -925,7 +925,7 @@ public class SignatureConfig {
* *
* @param signatureMethodUri the method uri * @param signatureMethodUri the method uri
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setSignatureMethodFromUri(final String signatureMethodUri) { public void setSignatureMethodFromUri(final String signatureMethodUri) {
switch (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 * @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() { public boolean isUpdateConfigOnValidate() {
return updateConfigOnValidate; return updateConfigOnValidate;
@ -1005,7 +1005,7 @@ public class SignatureConfig {
* *
* @param updateConfigOnValidate if true, update config on validate * @param updateConfigOnValidate if true, update config on validate
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setUpdateConfigOnValidate(boolean updateConfigOnValidate) { public void setUpdateConfigOnValidate(boolean updateConfigOnValidate) {
this.updateConfigOnValidate = updateConfigOnValidate; this.updateConfigOnValidate = updateConfigOnValidate;
@ -1014,7 +1014,7 @@ public class SignatureConfig {
/** /**
* @return true, if multiple signatures can be attached * @return true, if multiple signatures can be attached
* *
* @since POI 4.1.0 * @since 4.1.0
*/ */
public boolean isAllowMultipleSignatures() { public boolean isAllowMultipleSignatures() {
return allowMultipleSignatures; return allowMultipleSignatures;
@ -1026,7 +1026,7 @@ public class SignatureConfig {
* @param allowMultipleSignatures if true, the signature will be added, * @param allowMultipleSignatures if true, the signature will be added,
* otherwise all existing signatures will be replaced by the current * otherwise all existing signatures will be replaced by the current
* *
* @since POI 4.1.0 * @since 4.1.0
*/ */
public void setAllowMultipleSignatures(boolean allowMultipleSignatures) { public void setAllowMultipleSignatures(boolean allowMultipleSignatures) {
this.allowMultipleSignatures = allowMultipleSignatures; this.allowMultipleSignatures = allowMultipleSignatures;
@ -1035,7 +1035,7 @@ public class SignatureConfig {
/** /**
* @return is secure validation enabled? * @return is secure validation enabled?
* *
* @since POI 5.2.0 * @since 5.2.0
*/ */
public boolean isSecureValidation() { public boolean isSecureValidation() {
return secureValidation; return secureValidation;
@ -1061,7 +1061,7 @@ public class SignatureConfig {
* *
* @see <a href="https://santuario.apache.org/faq.html#faq-4.SecureValidation">XmlSec SecureValidation</a> * @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) { public void setSecureValidation(boolean secureValidation) {
this.secureValidation = secureValidation; this.secureValidation = secureValidation;

View File

@ -37,7 +37,7 @@ public class XDDFLineProperties {
/** /**
* @param fill * @param fill
* fill properties to set on the new line properties. * fill properties to set on the new line properties.
* @since POI 4.0.2 * @since 4.0.2
*/ */
public XDDFLineProperties(XDDFFillProperties fill) { public XDDFLineProperties(XDDFFillProperties fill) {
this(); this();

View File

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

View File

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

View File

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

View File

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

View File

@ -32,7 +32,7 @@ import org.openxmlformats.schemas.drawingml.x2006.chart.CTSerTx;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumData; import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumData;
/** /**
* @since POI 5.2.3 * @since 5.2.3
*/ */
@Beta @Beta
public class XDDFBubbleChartData extends XDDFChartData { 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() { public CTBubbleSer getCTBubbleSer() {
return series; return series;

View File

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

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 * the package part holding the chart data, the content type must
* be * be
* {@code application/vnd.openxmlformats-officedocument.drawingml.chart+xml} * {@code application/vnd.openxmlformats-officedocument.drawingml.chart+xml}
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
protected XDDFChart(PackagePart part) throws IOException, XmlException { protected XDDFChart(PackagePart part) throws IOException, XmlException {
super(part); 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. * Clear all properties, as if a new instance had just been created.
* @since POI 4.1.2 * @since 4.1.2
*/ */
public void clear() { public void clear() {
axes.clear(); axes.clear();
@ -322,7 +322,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
/** /**
* Remove the chart title. * Remove the chart title.
* @since POI 5.0.0 * @since 5.0.0
*/ */
public void removeTitle() { public void removeTitle() {
setAutoTitleDeleted(true); 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. * 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() { public void clearChartSeries() {
CTPlotArea plotArea = getCTPlotArea(); CTPlotArea plotArea = getCTPlotArea();
@ -758,7 +758,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* index used to suffix on file * index used to suffix on file
* @return return relation part which used to write relation in .rels file * @return return relation part which used to write relation in .rels file
* and get relation id * and get relation id
* @since POI 4.0.0 * @since 4.0.0
*/ */
public PackageRelationship createRelationshipInChart(POIXMLRelation chartRelation, POIXMLFactory chartFactory, public PackageRelationship createRelationshipInChart(POIXMLRelation chartRelation, POIXMLFactory chartFactory,
int chartIndex) { int chartIndex) {
@ -775,7 +775,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param chartFactory * @param chartFactory
* factory object of POIXMLFactory (XWPFFactory/XSLFFactory) * factory object of POIXMLFactory (XWPFFactory/XSLFFactory)
* @return return the new package part * @return return the new package part
* @since POI 4.0.0 * @since 4.0.0
*/ */
private PackagePart createWorksheetPart(POIXMLRelation chartWorkbookRelation, POIXMLFactory chartFactory) private PackagePart createWorksheetPart(POIXMLRelation chartWorkbookRelation, POIXMLFactory chartFactory)
throws InvalidFormatException { 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 * this method write the XSSFWorkbook object data into embedded excel file
* *
* @param workbook XSSFworkbook object * @param workbook XSSFworkbook object
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void saveWorkbook(XSSFWorkbook workbook) throws IOException, InvalidFormatException { public void saveWorkbook(XSSFWorkbook workbook) throws IOException, InvalidFormatException {
PackagePart worksheetPart = getWorksheetPart(); PackagePart worksheetPart = getWorksheetPart();
@ -810,21 +810,21 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
/** /**
* *
* @return the chart relation in the implementing subclass. * @return the chart relation in the implementing subclass.
* @since POI 4.0.0 * @since 4.0.0
*/ */
protected abstract POIXMLRelation getChartRelation(); protected abstract POIXMLRelation getChartRelation();
/** /**
* *
* @return the chart workbook relation in the implementing subclass. * @return the chart workbook relation in the implementing subclass.
* @since POI 4.0.0 * @since 4.0.0
*/ */
protected abstract POIXMLRelation getChartWorkbookRelation(); protected abstract POIXMLRelation getChartWorkbookRelation();
/** /**
* *
* @return the chart factory in the implementing subclass. * @return the chart factory in the implementing subclass.
* @since POI 4.0.0 * @since 4.0.0
*/ */
protected abstract POIXMLFactory getChartFactory(); protected abstract POIXMLFactory getChartFactory();
@ -837,7 +837,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* category values * category values
* @param valuesData * @param valuesData
* data values * data values
* @since POI 4.0.0 * @since 4.0.0
*/ */
protected void fillSheet(XSSFSheet sheet, XDDFDataSource<?> categoryData, XDDFNumericalDataSource<?> valuesData) { protected void fillSheet(XSSFSheet sheet, XDDFDataSource<?> categoryData, XDDFNumericalDataSource<?> valuesData) {
int numOfPoints = categoryData.getPointCount(); int numOfPoints = categoryData.getPointCount();
@ -862,7 +862,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param index * @param index
* index of current row * index of current row
* @return this method return sheet row on given index * @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) { private XSSFRow getRow(XSSFSheet sheet, int index) {
XSSFRow row = sheet.getRow(index); XSSFRow row = sheet.getRow(index);
@ -882,7 +882,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param index * @param index
* index of current cell * index of current cell
* @return this method return sheet cell on given index * @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) { private XSSFCell getCell(XSSFRow row, int index) {
XSSFCell cell = row.getCell(index); XSSFCell cell = row.getCell(index);
@ -898,7 +898,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* *
* @param other * @param other
* chart object * chart object
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void importContent(XDDFChart other) { public void importContent(XDDFChart other) {
getCTChartSpace().set(other.getCTChartSpace()); getCTChartSpace().set(other.getCTChartSpace());
@ -935,7 +935,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param column * @param column
* column index * column index
* @return return cell reference * @return return cell reference
* @since POI 4.0.0 * @since 4.0.0
*/ */
public CellReference setSheetTitle(String title, int column) { public CellReference setSheetTitle(String title, int column) {
XSSFSheet sheet = getSheet(); 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) { public String formatRange(CellRangeAddress range) {
final XSSFSheet sheet = getSheet(); final XSSFSheet sheet = getSheet();
@ -961,7 +961,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* get sheet object of embedded excel file * get sheet object of embedded excel file
* *
* @return excel sheet object * @return excel sheet object
* @since POI 4.0.0 * @since 4.0.0
*/ */
private XSSFSheet getSheet() { private XSSFSheet getSheet() {
try { try {
@ -977,7 +977,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* writing xssfworkbook object into output stream of embedded part * writing xssfworkbook object into output stream of embedded part
* *
* @return returns the packagepart of embedded file * @return returns the packagepart of embedded file
* @since POI 4.0.0 * @since 4.0.0
*/ */
private PackagePart getWorksheetPart() throws InvalidFormatException { private PackagePart getWorksheetPart() throws InvalidFormatException {
for (RelationPart part : getRelationParts()) { 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 * @return returns the workbook object of embedded excel file
* @since POI 4.0.0 * @since 4.0.0
*/ */
public XSSFWorkbook getWorkbook() throws IOException, InvalidFormatException { public XSSFWorkbook getWorkbook() throws IOException, InvalidFormatException {
if (workbook == null) { if (workbook == null) {
@ -1028,7 +1028,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* *
* @param workbook * @param workbook
* workbook object which we read from chart embedded part * workbook object which we read from chart embedded part
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setWorkbook(XSSFWorkbook workbook) { public void setWorkbook(XSSFWorkbook workbook) {
this.workbook = workbook; this.workbook = workbook;
@ -1041,7 +1041,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param id * @param id
* relation id of embedded excel relation id into external data * relation id of embedded excel relation id into external data
* relation tag * relation tag
* @since POI 4.0.0 * @since 4.0.0
*/ */
public void setExternalId(String id) { public void setExternalId(String id) {
CTChartSpace ctChartSpace = getCTChartSpace(); CTChartSpace ctChartSpace = getCTChartSpace();
@ -1053,7 +1053,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
/** /**
* @return method return chart index * @return method return chart index
* @since POI 4.0.0 * @since 4.0.0
*/ */
protected int getChartIndex() { protected int getChartIndex() {
return chartIndex; return chartIndex;
@ -1075,7 +1075,7 @@ public abstract class XDDFChart extends POIXMLDocumentPart implements TextContai
* @param newSheet * @param newSheet
* sheet to be used in the data references. * sheet to be used in the data references.
* *
* @since POI 5.1.0 * @since 5.1.0
*/ */
public void replaceReferences(XSSFSheet newSheet) { public void replaceReferences(XSSFSheet newSheet) {
for (XDDFChartData data : getChartSeries()) { for (XDDFChartData data : getChartSeries()) {

View File

@ -65,7 +65,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties {
public abstract XDDFShapeProperties getOrAddMinorGridProperties(); public abstract XDDFShapeProperties getOrAddMinorGridProperties();
/** /**
* @since POI 4.0.2 * @since 4.0.2
*/ */
public abstract XDDFRunProperties getOrAddTextProperties(); public abstract XDDFRunProperties getOrAddTextProperties();
@ -357,7 +357,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties {
/** /**
* @return tick label position. * @return tick label position.
* @since POI 4.0.2 * @since 4.0.2
*/ */
public AxisTickLabelPosition getTickLabelPosition() { public AxisTickLabelPosition getTickLabelPosition() {
return AxisTickLabelPosition.valueOf(getCTTickLblPos().getVal()); return AxisTickLabelPosition.valueOf(getCTTickLblPos().getVal());
@ -366,7 +366,7 @@ public abstract class XDDFChartAxis implements HasShapeProperties {
/** /**
* @param labelPosition * @param labelPosition
* tick label position. * tick label position.
* @since POI 4.0.2 * @since 4.0.2
*/ */
public void setTickLabelPosition(AxisTickLabelPosition labelPosition) { public void setTickLabelPosition(AxisTickLabelPosition labelPosition) {
getCTTickLblPos().setVal(labelPosition.underlying); getCTTickLblPos().setVal(labelPosition.underlying);

View File

@ -159,7 +159,7 @@ public abstract class XDDFChartData {
/** /**
* Set the Chart Series title. * Set the Chart Series title.
* @param title chart series title * @param title chart series title
* @since POI 5.2.3 * @since 5.2.3
*/ */
public void setTitle(String title) { public void setTitle(String title) {
setTitle(title, null); setTitle(title, null);
@ -224,7 +224,7 @@ public abstract class XDDFChartData {
/** /**
* @param fill * @param fill
* fill property for the shape representing the series. * fill property for the shape representing the series.
* @since POI 4.1.1 * @since 4.1.1
*/ */
public void setFillProperties(XDDFFillProperties fill) { public void setFillProperties(XDDFFillProperties fill) {
XDDFShapeProperties properties = getShapeProperties(); XDDFShapeProperties properties = getShapeProperties();
@ -238,7 +238,7 @@ public abstract class XDDFChartData {
/** /**
* @param line * @param line
* line property for the shape representing the series. * line property for the shape representing the series.
* @since POI 4.1.1 * @since 4.1.1
*/ */
public void setLineProperties(XDDFLineProperties line) { public void setLineProperties(XDDFLineProperties line) {
XDDFShapeProperties properties = getShapeProperties(); XDDFShapeProperties properties = getShapeProperties();
@ -255,7 +255,7 @@ public abstract class XDDFChartData {
* *
* @param index * @param index
* data point index. * data point index.
* @since POI 5.1.0 * @since 5.1.0
*/ */
public void clearDataPoint(long index) { public void clearDataPoint(long index) {
List<CTDPt> points = getDPtList(); List<CTDPt> points = getDPtList();
@ -275,7 +275,7 @@ public abstract class XDDFChartData {
* data point index. * data point index.
* @return * @return
* the data point with the given {@code index}. * the data point with the given {@code index}.
* @since POI 5.1.0 * @since 5.1.0
*/ */
public XDDFDataPoint getDataPoint(long index) { public XDDFDataPoint getDataPoint(long index) {
List<CTDPt> points = getDPtList(); List<CTDPt> points = getDPtList();

View File

@ -33,12 +33,12 @@ public interface XDDFDataSource<T> {
T getPointAt(int index); T getPointAt(int index);
/** /**
* @since POI 4.0.2 * @since 4.0.2
*/ */
boolean isLiteral(); boolean isLiteral();
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
boolean isCellRange(); boolean isCellRange();
@ -57,7 +57,7 @@ public interface XDDFDataSource<T> {
String getFormatCode(); String getFormatCode();
/** /**
* @since POI 5.0.0 * @since 5.0.0
*/ */
@Internal @Internal
default void fillNumericalCache(CTNumData cache) { default void fillNumericalCache(CTNumData cache) {
@ -95,7 +95,7 @@ public interface XDDFDataSource<T> {
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
@Internal @Internal
default void fillStringCache(CTStrData cache) { default void fillStringCache(CTStrData cache) {

View File

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

View File

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

View File

@ -27,7 +27,7 @@ import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumDataSource;
import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumRef; import org.openxmlformats.schemas.drawingml.x2006.chart.CTNumRef;
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
@Beta @Beta
public class XDDFErrorBars { public class XDDFErrorBars {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -122,7 +122,7 @@ public class XDDFScatterChartData extends XDDFChartData {
} }
/** /**
* @since POI 5.2.3 * @since 5.2.3
*/ */
public CTScatterSer getCTScatterSer() { public CTScatterSer getCTScatterSer() {
return series; return series;
@ -205,35 +205,35 @@ public class XDDFScatterChartData extends XDDFChartData {
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
public int getErrorBarsCount() { public int getErrorBarsCount() {
return series.sizeOfErrBarsArray(); return series.sizeOfErrBarsArray();
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
public XDDFErrorBars getErrorBars(int index) { public XDDFErrorBars getErrorBars(int index) {
return new XDDFErrorBars(series.getErrBarsArray(index)); return new XDDFErrorBars(series.getErrBarsArray(index));
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
public XDDFErrorBars addNewErrorBars() { public XDDFErrorBars addNewErrorBars() {
return new XDDFErrorBars(series.addNewErrBars()); return new XDDFErrorBars(series.addNewErrBars());
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
public XDDFErrorBars insertNewErrorBars(int index) { public XDDFErrorBars insertNewErrorBars(int index) {
return new XDDFErrorBars(series.insertNewErrBars(index)); return new XDDFErrorBars(series.insertNewErrBars(index));
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
public void removeErrorBars(int index) { public void removeErrorBars(int index) {
series.removeErrBars(index); series.removeErrBars(index);

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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) { protected POIXMLRelation getDescriptor(String relationshipType) {
return XDGFRelation.getInstance(relationshipType); return XDGFRelation.getInstance(relationshipType);

View File

@ -34,7 +34,7 @@ public class XDGFMasterContents extends XDGFBaseContents {
protected XDGFMaster _master; protected XDGFMaster _master;
/** /**
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public XDGFMasterContents(PackagePart part) { public XDGFMasterContents(PackagePart part) {
super(part); super(part);

View File

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

View File

@ -35,7 +35,7 @@ public class XDGFPageContents extends XDGFBaseContents {
protected XDGFPage _page; protected XDGFPage _page;
/** /**
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public XDGFPageContents(PackagePart part) { public XDGFPageContents(PackagePart part) {
super(part); super(part);

View File

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

View File

@ -93,7 +93,7 @@ public class XmlVisioDocument extends POIXMLDocument {
* @param stream InputStream * @param stream InputStream
* @param closeStream Whether to close the InputStream * @param closeStream Whether to close the InputStream
* @throws IOException If parsing the document fails * @throws IOException If parsing the document fails
* @since POI 5.2.5 * @since 5.2.5
*/ */
public XmlVisioDocument(InputStream stream, boolean closeStream) throws IOException { public XmlVisioDocument(InputStream stream, boolean closeStream) throws IOException {
this(PackageHelper.open(stream, closeStream)); this(PackageHelper.open(stream, closeStream));

View File

@ -26,14 +26,14 @@ public class XDGFXMLDocumentPart extends POIXMLDocumentPart {
protected XDGFDocument _document; protected XDGFDocument _document;
/** /**
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public XDGFXMLDocumentPart(PackagePart part) { public XDGFXMLDocumentPart(PackagePart part) {
super(part); super(part);
} }
/** /**
* @since POI 4.1.2 * @since 4.1.2
*/ */
@Internal @Internal
public void setDocument(XDGFDocument document) { public void setDocument(XDGFDocument document) {

View File

@ -32,7 +32,7 @@ import org.apache.poi.xslf.usermodel.XMLSlideShow;
* throw {@link XSLFReadException} or {@link IOException} instead of {@link RuntimeException}. * throw {@link XSLFReadException} or {@link IOException} instead of {@link RuntimeException}.
* You can still get an {@link Error}s like an {@link OutOfMemoryError}. * 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 { public final class XSLFParser {

View File

@ -26,7 +26,7 @@ import org.apache.poi.POIException;
* exceptions, but this is not a good practice. This class is a checked * exceptions, but this is not a good practice. This class is a checked
* class that extends {@link Exception} so needs to be explicitly * class that extends {@link Exception} so needs to be explicitly
* caught or declared in the method signature.</p> * caught or declared in the method signature.</p>
* @since POI 5.5.0 * @since 5.5.0
*/ */
public class XSLFReadException extends POIException { public class XSLFReadException extends POIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

View File

@ -151,7 +151,7 @@ public class XMLSlideShow extends POIXMLDocument
* @throws POIXMLException a RuntimeException that can be caused by invalid OOXML data * @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 * @throws IllegalStateException a number of other runtime exceptions can be thrown, especially if there are problems with the
* input format * input format
* @since POI 5.2.5 * @since 5.2.5
*/ */
public XMLSlideShow(InputStream stream, boolean closeStream) throws IOException { public XMLSlideShow(InputStream stream, boolean closeStream) throws IOException {
this(PackageHelper.open(stream, closeStream)); this(PackageHelper.open(stream, closeStream));
@ -341,7 +341,7 @@ public class XMLSlideShow extends POIXMLDocument
/** /**
* This method is used to create template for chart XML. * This method is used to create template for chart XML.
* @return Xslf chart object * @return Xslf chart object
* @since POI 4.1.0 * @since 4.1.0
*/ */
public XSLFChart createChart() { public XSLFChart createChart() {
int chartIdx = findNextAvailableFileNameIndex(XSLFRelation.CHART); int chartIdx = findNextAvailableFileNameIndex(XSLFRelation.CHART);

View File

@ -62,7 +62,7 @@ public final class XSLFChart extends XDDFChart {
* *
* @param part the package part holding the chart data, * @param part the package part holding the chart data,
* the content type must be <code>application/vnd.openxmlformats-officedocument.drawingml.chart+xml</code> * 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 { protected XSLFChart(PackagePart part) throws IOException, XmlException {
super(part); super(part);
@ -112,7 +112,7 @@ public final class XSLFChart extends XDDFChart {
* @param rID relation id * @param rID relation id
* @param anchor size and location of chart * @param anchor size and location of chart
* @return graphic frame object * @return graphic frame object
* @since POI 4.1.0 * @since 4.1.0
*/ */
static CTGraphicalObjectFrame prototype(int shapeId, String rID, Rectangle2D anchor) { static CTGraphicalObjectFrame prototype(int shapeId, String rID, Rectangle2D anchor) {
CTGraphicalObjectFrame frame = CTGraphicalObjectFrame.Factory.newInstance(); CTGraphicalObjectFrame frame = CTGraphicalObjectFrame.Factory.newInstance();

View File

@ -33,7 +33,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.CTCommentAuthorList;
/** /**
* XSLF Comment * XSLF Comment
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public class XSLFComment implements Comment { public class XSLFComment implements Comment {

View File

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

View File

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

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. * 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. * Integrating such a change into POI would be quite sophisticated and challenging.
* *
* @since POI 5.2.3 * @since 5.2.3
*/ */
@Beta @Beta
public class XSLFDiagram extends XSLFGraphicFrame { public class XSLFDiagram extends XSLFGraphicFrame {

View File

@ -113,7 +113,7 @@ public class XSLFDrawing {
* *
* @param rID relation id of chart * @param rID relation id of chart
* @param rect2D Chart Bounding values * @param rect2D Chart Bounding values
* @since POI 4.1.0 * @since 4.1.0
*/ */
public void addChart(String rID, Rectangle2D rect2D) { public void addChart(String rID, Rectangle2D rect2D) {
CTGraphicalObjectFrame sp = _spTree.addNewGraphicFrame(); CTGraphicalObjectFrame sp = _spTree.addNewGraphicFrame();

View File

@ -35,7 +35,7 @@ public final class XSLFFactory extends POIXMLFactory {
private XSLFFactory() {} private XSLFFactory() {}
/** /**
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
@Override @Override
protected POIXMLRelation getDescriptor(String relationshipType) { protected POIXMLRelation getDescriptor(String relationshipType) {

View File

@ -31,7 +31,7 @@ import org.apache.poi.util.Beta;
* A container for fontdata files, i.e. MTX fonts derived from * A container for fontdata files, i.e. MTX fonts derived from
* true (TTF) or open (OTF) type fonts. * true (TTF) or open (OTF) type fonts.
* *
* @since POI 4.1.0 * @since 4.1.0
*/ */
@Beta @Beta
public class XSLFFontData extends POIXMLDocumentPart { public class XSLFFontData extends POIXMLDocumentPart {

View File

@ -255,7 +255,7 @@ public class XSLFFontInfo implements FontInfo {
* @return a font data object * @return a font data object
* @throws IOException if the font data can't be stored * @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) public static XSLFFontInfo addFontToSlideShow(XMLSlideShow ppt, InputStream fontStream)
throws IOException { throws IOException {

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() { public boolean hasDiagram() {
String uri = getGraphicalData().getUri(); String uri = getGraphicalData().getUri();

View File

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

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 { protected XSLFNotesMaster(PackagePart part) throws IOException, XmlException {
super(part); super(part);

View File

@ -47,7 +47,7 @@ public final class XSLFObjectData extends POIXMLDocumentPart implements ObjectDa
* *
* @param part the package part holding the ole data * @param part the package part holding the ole data
* *
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public XSLFObjectData(final PackagePart part) { public XSLFObjectData(final PackagePart part) {
super(part); super(part);

View File

@ -80,7 +80,7 @@ public final class XSLFPictureData extends POIXMLDocumentPart implements Picture
* *
* @param part the package part holding the drawing data * @param part the package part holding the drawing data
* *
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
public XSLFPictureData(PackagePart part) { public XSLFPictureData(PackagePart part) {
super(part); super(part);

View File

@ -229,7 +229,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
* Add a SVG image reference * Add a SVG image reference
* @param svgPic a previously imported svg image * @param svgPic a previously imported svg image
* *
* @since POI 4.1.0 * @since 4.1.0
*/ */
public void setSvgImage(XSLFPictureData svgPic) { public void setSvgImage(XSLFPictureData svgPic) {
CTBlip blip = getBlip(); CTBlip blip = getBlip();
@ -275,7 +275,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
/** /**
* @return picture name, can be null * @return picture name, can be null
* @since POI 5.1.0 * @since 5.1.0
*/ */
public String getName() { public String getName() {
String name = null; String name = null;
@ -292,7 +292,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
/** /**
* @param name picture name * @param name picture name
* @return returns true if the name was set * @return returns true if the name was set
* @since POI 5.1.0 * @since 5.1.0
*/ */
public boolean setName(String name) { public boolean setName(String name) {
XmlObject xmlObject = getXmlObject(); XmlObject xmlObject = getXmlObject();
@ -349,7 +349,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
* @param anchor the image anchor (for calculating the preview image size) or * @param anchor the image anchor (for calculating the preview image size) or
* null (the preview size is taken from the svg picture bounds) * 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 { 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 * @return boolean; true if the picture is a video
* @since POI 5.2.0 * @since 5.2.0
*/ */
public boolean isVideoFile() { public boolean isVideoFile() {
CTPictureNonVisual nvPicPr = getCTPictureNonVisual(); CTPictureNonVisual nvPicPr = getCTPictureNonVisual();
@ -454,7 +454,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
/** /**
* @return the link ID for the video file * @return the link ID for the video file
* @since POI 5.2.0 * @since 5.2.0
*/ */
public String getVideoFileLink() { public String getVideoFileLink() {
if (isVideoFile()) { if (isVideoFile()) {
@ -476,7 +476,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
/** /**
* @return boolean; true if the picture is an audio * @return boolean; true if the picture is an audio
* @since POI 5.2.4 * @since 5.2.4
*/ */
public boolean isAudioFile() { public boolean isAudioFile() {
CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing(); CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing();
@ -485,7 +485,7 @@ public class XSLFPictureShape extends XSLFSimpleShape
/** /**
* @return the link ID for the audio file * @return the link ID for the audio file
* @since POI 5.2.4 * @since 5.2.4
*/ */
public String getAudioFileLink() { public String getAudioFileLink() {
CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing(); CTApplicationNonVisualDrawingProps nvPr = getCTApplicationNonVisualDrawing();

View File

@ -40,7 +40,7 @@ import org.openxmlformats.schemas.presentationml.x2006.main.STPlaceholderType;
/** /**
* XSLF Placeholder Details * XSLF Placeholder Details
* *
* @since POI 4.0.0 * @since 4.0.0
*/ */
public class XSLFPlaceholderDetails implements PlaceholderDetails { public class XSLFPlaceholderDetails implements PlaceholderDetails {

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. * 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 * Maybe the xml schemas might be enhanced with interfaces to make this class superfluous
* *
* @since POI 3.15-beta2 * @since 3.15-beta2
*/ */
@Internal @Internal
/* package */ class XSLFPropertiesDelegate { /* package */ class XSLFPropertiesDelegate {

View File

@ -93,7 +93,7 @@ implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph> {
} }
/** /**
* @since POI 3.14-Beta1 * @since 3.14-Beta1
*/ */
protected XSLFSheet(PackagePart part) { protected XSLFSheet(PackagePart part) {
super(part); super(part);
@ -719,7 +719,7 @@ implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph> {
* this method will add chart into slide * this method will add chart into slide
* with default height, width, x and y * with default height, width, x and y
* @param chart xslf chart object * @param chart xslf chart object
* @since POI 4.1.0 * @since 4.1.0
*/ */
public void addChart(XSLFChart chart) { public void addChart(XSLFChart chart) {
Rectangle2D rect2D = new Rectangle(XDDFChart.DEFAULT_X, XDDFChart.DEFAULT_Y, 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 * this method will add chart into slide
* with given height, width, x and y * with given height, width, x and y
* @param chart xslf chart object * @param chart xslf chart object
* @since POI 4.1.0 * @since 4.1.0
*/ */
public void addChart(XSLFChart chart, Rectangle2D rect2D) { public void addChart(XSLFChart chart, Rectangle2D rect2D) {
RelationPart rp = addRelation(null, XSLFRelation.CHART, chart); RelationPart rp = addRelation(null, XSLFRelation.CHART, chart);

View File

@ -73,7 +73,7 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
* @param part the package part holding the slide data, * @param part the package part holding the slide data,
* the content type must be {@code application/vnd.openxmlformats-officedocument.slide+xml} * 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 { XSLFSlide(PackagePart part) throws IOException, XmlException {
super(part); super(part);
@ -165,7 +165,7 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
/** /**
* @return the comments part or {@code null} if there weren't any comments * @return the comments part or {@code null} if there weren't any comments
* @since POI 4.0.0 * @since 4.0.0
*/ */
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
public XSLFComments getCommentsPart() { 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 * @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") @SuppressWarnings("WeakerAccess")
public XSLFCommentAuthors getCommentAuthorsPart() { public XSLFCommentAuthors getCommentAuthorsPart() {

View File

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

View File

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

View File

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

View File

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

View File

@ -84,7 +84,7 @@ public class XSLFTableRow implements Iterable<XSLFTableCell> {
/** /**
* Insert a new cell at the given index. * Insert a new cell at the given index.
* @param colIdx the column index. * @param colIdx the column index.
* @since POI 4.1.2 * @since 4.1.2
*/ */
public XSLFTableCell insertCell(int colIdx){ public XSLFTableCell insertCell(int colIdx){
CTTableCell c = _row.insertNewTc(colIdx); CTTableCell c = _row.insertNewTc(colIdx);
@ -102,7 +102,7 @@ public class XSLFTableRow implements Iterable<XSLFTableCell> {
/** /**
* Remove the cell at the given index. * Remove the cell at the given index.
* @param colIdx the column index. * @param colIdx the column index.
* @since POI 4.1.2 * @since 4.1.2
*/ */
public void removeCell(int colIdx){ public void removeCell(int colIdx){
if (_row.sizeOfTcArray() < colIdx) { if (_row.sizeOfTcArray() < colIdx) {

View File

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

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 { public XSLFTableStyles(PackagePart part) throws IOException, XmlException {
super(part); super(part);

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

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 org.apache.poi.sl.draw.DrawPaint#getPaint(java.awt.Graphics2D, PaintStyle)
* @see SolidPaint#getSolidColor() * @see SolidPaint#getSolidColor()
* @since POI 5.2.4 * @since 5.2.4
*/ */
@Override @Override
public PaintStyle getHighlightColor() { 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 * Sets the font highlight (background) color for this text run - convenience function
* *
* @param color The highlight (background) color to set. * @param color The highlight (background) color to set.
* @since POI 5.2.4 * @since 5.2.4
*/ */
@Override @Override
public void setHighlightColor(final Color color) { 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. * @throws IllegalArgumentException If the supplied paint style is not null or a SolidPaint.
* *
* @see org.apache.poi.sl.draw.DrawPaint#createSolidPaint(Color) * @see org.apache.poi.sl.draw.DrawPaint#createSolidPaint(Color)
* @since POI 5.2.4 * @since 5.2.4
*/ */
@Override @Override
public void setHighlightColor(final PaintStyle color) { public void setHighlightColor(final PaintStyle color) {

View File

@ -90,7 +90,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape
} }
/** /**
* @since POI 5.2.0 * @since 5.2.0
*/ */
@Override @Override
public Spliterator<XSLFTextParagraph> spliterator() { public Spliterator<XSLFTextParagraph> spliterator() {
@ -239,7 +239,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape
/** /**
* @param paragraph paragraph to remove * @param paragraph paragraph to remove
* @return whether the paragraph was removed * @return whether the paragraph was removed
* @since POI 5.2.2 * @since 5.2.2
*/ */
public boolean removeTextParagraph(XSLFTextParagraph paragraph) { public boolean removeTextParagraph(XSLFTextParagraph paragraph) {
CTTextParagraph ctTextParagraph = paragraph.getXmlObject(); CTTextParagraph ctTextParagraph = paragraph.getXmlObject();
@ -807,7 +807,7 @@ public abstract class XSLFTextShape extends XSLFSimpleShape
* *
* @return a new text paragraph * @return a new text paragraph
* *
* @since POI 3.15-beta2 * @since 3.15-beta2
*/ */
protected XSLFTextParagraph newTextParagraph(CTTextParagraph p) { protected XSLFTextParagraph newTextParagraph(CTTextParagraph p) {
return new XSLFTextParagraph(p, this); return new XSLFTextParagraph(p, this);

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 { public XSLFTheme(PackagePart part) throws IOException, XmlException {
super(part); super(part);

View File

@ -31,7 +31,7 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
* throw {@link XSSFReadException} or {@link IOException} instead of {@link RuntimeException}. * throw {@link XSSFReadException} or {@link IOException} instead of {@link RuntimeException}.
* You can still get an {@link Error}s like an {@link OutOfMemoryError}. * 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 { public final class XSSFParser {

View File

@ -26,7 +26,7 @@ import org.apache.poi.POIException;
* exceptions, but this is not a good practice. This class is a checked * exceptions, but this is not a good practice. This class is a checked
* class that extends {@link Exception} so needs to be explicitly * class that extends {@link Exception} so needs to be explicitly
* caught or declared in the method signature.</p> * caught or declared in the method signature.</p>
* @since POI 5.5.0 * @since 5.5.0
*/ */
public class XSSFReadException extends POIException { public class XSSFReadException extends POIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

View File

@ -69,7 +69,7 @@ public class XSSFBSheetHandler extends XSSFBParser {
* @param comments optional comments table, may be {@code null} * @param comments optional comments table, may be {@code null}
* @param strings shared strings table used by the sheet * @param strings shared strings table used by the sheet
* @param sheetContentsHandler callback receiving native cell events * @param sheetContentsHandler callback receiving native cell events
* @since POI 5.5.0 * @since 5.5.0
*/ */
public XSSFBSheetHandler(InputStream is, public XSSFBSheetHandler(InputStream is,
XSSFBStylesTable styles, XSSFBStylesTable styles,
@ -414,7 +414,7 @@ public class XSSFBSheetHandler extends XSSFBParser {
* Receives streaming callbacks while {@link XSSFBSheetHandler} parses an XLSB sheet. * Receives streaming callbacks while {@link XSSFBSheetHandler} parses an XLSB sheet.
* *
* @see XSSFBSheetHandler * @see XSSFBSheetHandler
* @since POI 5.5.0 * @since 5.5.0
*/ */
public interface XSSFBSheetContentsHandler { public interface XSSFBSheetContentsHandler {
/** /**

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 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 * @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 IOException If reading the data from the package fails.
* @throws SAXException if parsing the XML data 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 * Calls {@link #ReadOnlySharedStringsTable(PackagePart, boolean)}, with a
* value of <code>true</code> to include phonetic runs. * 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 { public ReadOnlySharedStringsTable(PackagePart part) throws IOException, SAXException {
this(part, true); this(part, true);
} }
/** /**
* @since POI 3.14-Beta3 * @since 3.14-Beta3
*/ */
public ReadOnlySharedStringsTable(PackagePart part, boolean includePhoneticRuns) public ReadOnlySharedStringsTable(PackagePart part, boolean includePhoneticRuns)
throws IOException, SAXException { 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) public ReadOnlySharedStringsTable(InputStream stream)
throws IOException, SAXException { 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) public ReadOnlySharedStringsTable(InputStream stream, boolean includePhoneticRuns)
throws IOException, SAXException { throws IOException, SAXException {

View File

@ -107,7 +107,7 @@ public class XSSFBReader extends XSSFReader {
* @return iterator of {@link InputStream}s * @return iterator of {@link InputStream}s
* @throws InvalidFormatException if the sheet data format is invalid * @throws InvalidFormatException if the sheet data format is invalid
* @throws IOException if there is an I/O issue reading the data * @throws IOException if there is an I/O issue reading the data
* @since POI 5.4.0 * @since 5.4.0
*/ */
@Override @Override
public SheetIterator getSheetIterator() throws IOException, InvalidFormatException { public SheetIterator getSheetIterator() throws IOException, InvalidFormatException {

View File

@ -127,7 +127,7 @@ public class XSSFReader {
* *
* @param useReadOnlySharedStringsTable if true, the ReadOnlySharedStringsTable is used, * @param useReadOnlySharedStringsTable if true, the ReadOnlySharedStringsTable is used,
* SharedStringsTable otherwise * SharedStringsTable otherwise
* @since POI 5.2.0 * @since 5.2.0
*/ */
public void setUseReadOnlySharedStringsTable(boolean useReadOnlySharedStringsTable) { public void setUseReadOnlySharedStringsTable(boolean useReadOnlySharedStringsTable) {
this.useReadOnlySharedStringsTable = useReadOnlySharedStringsTable; this.useReadOnlySharedStringsTable = useReadOnlySharedStringsTable;
@ -136,7 +136,7 @@ public class XSSFReader {
/** /**
* @return whether {@link #getSharedStringsTable()} uses {@link SharedStringsTable} * @return whether {@link #getSharedStringsTable()} uses {@link SharedStringsTable}
* or {@link ReadOnlySharedStringsTable}. * or {@link ReadOnlySharedStringsTable}.
* @since POI 5.2.0 * @since 5.2.0
*/ */
public boolean useReadOnlySharedStringsTable() { public boolean useReadOnlySharedStringsTable() {
return useReadOnlySharedStringsTable; return useReadOnlySharedStringsTable;
@ -280,7 +280,7 @@ public class XSSFReader {
* *
* @throws InvalidFormatException if the sheet data format is invalid * @throws InvalidFormatException if the sheet data format is invalid
* @throws IOException if there is an I/O issue reading the data * @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 { public SheetIterator getSheetIterator() throws IOException, InvalidFormatException {
return new SheetIterator(workbookPart); return new SheetIterator(workbookPart);

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 { public CalculationChain(PackagePart part) throws IOException {
super(part); super(part);

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 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). * 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 * @param sheet the sheet that this comments table is associated with
* @since POI 5.2.0 * @since 5.2.0
*/ */
@Internal @Internal
void setSheet(Sheet sheet); void setSheet(Sheet sheet);
@ -75,7 +75,7 @@ public interface Comments {
* Create a new comment and add to the CommentTable. * Create a new comment and add to the CommentTable.
* @param clientAnchor the anchor for this comment * @param clientAnchor the anchor for this comment
* @return new XSSFComment * @return new XSSFComment
* @since POI 5.2.0 * @since 5.2.0
*/ */
XSSFComment createNewComment(ClientAnchor clientAnchor); XSSFComment createNewComment(ClientAnchor clientAnchor);
@ -85,7 +85,7 @@ public interface Comments {
* @param oldReference the comment to remove from the commentRefs map * @param oldReference the comment to remove from the commentRefs map
* @param comment the comment to replace in the commentRefs map * @param comment the comment to replace in the commentRefs map
* @see #commentUpdated(XSSFComment) * @see #commentUpdated(XSSFComment)
* @since POI 5.2.0 * @since 5.2.0
*/ */
void referenceUpdated(CellAddress oldReference, XSSFComment comment); void referenceUpdated(CellAddress oldReference, XSSFComment comment);
@ -93,7 +93,7 @@ public interface Comments {
* Called after the comment is updated, so that * Called after the comment is updated, so that
* we can reflect that in our cache * we can reflect that in our cache
* @param comment the comment to replace in the commentRefs map * @param comment the comment to replace in the commentRefs map
* @since POI 5.2.0 * @since 5.2.0
* @see #referenceUpdated(CellAddress, XSSFComment) * @see #referenceUpdated(CellAddress, XSSFComment)
*/ */
void commentUpdated(XSSFComment comment); void commentUpdated(XSSFComment comment);

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 { public CommentsTable(PackagePart part) throws IOException {
super(part); super(part);
@ -115,7 +115,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
* @param oldReference the comment to remove from the commentRefs map * @param oldReference the comment to remove from the commentRefs map
* @param comment the comment to replace in the commentRefs map * @param comment the comment to replace in the commentRefs map
* @see #commentUpdated(XSSFComment) * @see #commentUpdated(XSSFComment)
* @since POI 5.2.0 * @since 5.2.0
*/ */
@Override @Override
public void referenceUpdated(CellAddress oldReference, XSSFComment comment) { 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 * Called after the comment is updated, so that
* we can reflect that in our cache * we can reflect that in our cache
* @param comment the comment to replace in the commentRefs map * @param comment the comment to replace in the commentRefs map
* @since POI 5.2.0 * @since 5.2.0
* @see #referenceUpdated(CellAddress, XSSFComment) * @see #referenceUpdated(CellAddress, XSSFComment)
*/ */
@Override @Override
@ -211,7 +211,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
* Create a new comment and add to the CommentTable. * Create a new comment and add to the CommentTable.
* @param clientAnchor the anchor for this comment * @param clientAnchor the anchor for this comment
* @return new XSSFComment * @return new XSSFComment
* @since POI 5.2.0 * @since 5.2.0
*/ */
@Override @Override
public XSSFComment createNewComment(ClientAnchor clientAnchor) { public XSSFComment createNewComment(ClientAnchor clientAnchor) {

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 { public ExternalLinksTable(PackagePart part) throws IOException {
super(part); super(part);

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