org.apache.poi.examples.hpsf.ReadTitle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi-examples Show documentation
Apache POI Examples
The newest version!
/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.apache.poi.examples.hpsf;

import java.io.File;
import java.io.IOException;

import org.apache.poi.hpsf.PropertySetFactory;
import org.apache.poi.hpsf.SummaryInformation;
import org.apache.poi.poifs.eventfilesystem.POIFSReader;
import org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent;

/**
 * Sample application showing how to read a OLE 2 document's
 * title. Call it with the document's file name as command line
 * parameter.
 *
 * Explanations can be found in the HPSF HOW-TO.
 */
@SuppressWarnings({"java:S106","java:S4823"})
public final class ReadTitle {
    private ReadTitle() {}

    /**
     * Runs the example program.
     *
     * @param args Command-line arguments. The first command-line argument must
     * be the name of a POI filesystem to read.
     * @throws IOException if any I/O exception occurs.
     */
    public static void main(final String[] args) throws IOException {
        final String filename = args[0];
        POIFSReader r = new POIFSReader();
        r.registerListener(ReadTitle::processPOIFSReaderEvent, SummaryInformation.DEFAULT_STREAM_NAME);
        r.read(new File(filename));
    }


    private static void processPOIFSReaderEvent(final POIFSReaderEvent event) {
        SummaryInformation si;
        try {
            si = (SummaryInformation) PropertySetFactory.create(event.getStream());
        } catch (Exception ex) {
            throw new RuntimeException("Property set stream \"" + event.getPath() + event.getName() + "\": " + ex);
        }
        final String title = si.getTitle();
        System.out.println(title != null ? "Title: \"" + title + "\"" : "Document has no title.");
    }
}