org.jodconverter.local.office.utils.Write Maven / Gradle / Ivy
Show all versions of jodconverter-local Show documentation
/*
* 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.text.XTextDocument;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* A collection of utility functions to make Office Text documents (Writer) easier to use.
*
* Inspired by the work of Dr. Andrew Davison from the website Java LibreOffice Programming.
*/
public final class Write { // NOPMD - Disable utility class name rule violation
/**
* Gets whether the given document is a Text document.
*
* @param document The document to test.
* @return {@code true} if the document is a Text document, {@code false} otherwise.
*/
public static boolean isText(final @NonNull XComponent document) {
return Info.isDocumentType(document, Lo.WRITER_SERVICE);
}
/**
* Casts the given document into a {@link XTextDocument}.
*
* @param document The document to cast.
* @return The {@link XTextDocument}, or null if the document is not a Text document.
*/
public static @Nullable XTextDocument getTextDoc(final @Nullable XComponent document) {
if (document == null) {
return null;
}
return Lo.qiOptional(XTextDocument.class, document).orElse(null);
}
// Suppresses default constructor, ensuring non-instantiability.
private Write() {
throw new AssertionError("Utility class must not be instantiated");
}
}