org.jodconverter.local.office.utils.Calc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jodconverter-local Show documentation

Module required in order to process local conversions for the Java OpenDocument Converter (JODConverter) project.

There is a newer version: 4.4.8

/*
 * Copyright 2004 - 2012 Mirko Nasato and contributors
 *           2016 - 2020 Simon Braconnier and contributors
 *
 * This file is part of JODConverter - Java OpenDocument Converter.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jodconverter.local.office.utils;

import com.sun.star.lang.XComponent;
import com.sun.star.sheet.XSpreadsheetDocument;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * A collection of utility functions to make Office Calc documents (Spreadsheet) easier to use.
 *
 * Inspired by the work of Dr. Andrew Davison from the website Java LibreOffice Programming.
 */
public final class Calc { // NOPMD - Disable utility class name rule violation

  /**
   * Gets whether the given document is a Spreadsheet document.
   *
   * @param document The document to test.
   * @return {@code true} if the document is a Spreadsheet document, {@code false} otherwise.
   */
  public static boolean isCalc(final @NonNull XComponent document) {
    return Info.isDocumentType(document, Lo.CALC_SERVICE);
  }

  /**
   * Casts the given document into a {@link XSpreadsheetDocument}.
   *
   * @param document The document to cast.
   * @return The {@link XSpreadsheetDocument}, or null if the document is not a Spreadsheet
   *     document.
   */
  public static @Nullable XSpreadsheetDocument getCalcDoc(final @Nullable XComponent document) {

    if (document == null) {
      return null;
    }

    return Lo.qiOptional(XSpreadsheetDocument.class, document).orElse(null);
  }

  // Suppresses default constructor, ensuring non-instantiability.
  private Calc() {
    throw new AssertionError("Utility class must not be instantiated");
  }
}