| /* ==================================================================== |
| 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.poifs.eventfilesystem; |
| |
| import org.apache.poi.hpsf.ClassID; |
| import org.apache.poi.poifs.filesystem.DocumentInputStream; |
| import org.apache.poi.poifs.filesystem.POIFSDocumentPath; |
| |
| /** |
| * Class POIFSReaderEvent |
| */ |
| |
| public class POIFSReaderEvent { |
| private final DocumentInputStream stream; |
| private final POIFSDocumentPath path; |
| private final String documentName; |
| private final ClassID storageClassId; |
| |
| /** |
| * package scoped constructor |
| * |
| * @param stream the DocumentInputStream, freshly opened |
| * @param path the path of the document |
| * @param documentName the name of the document |
| */ |
| POIFSReaderEvent(final DocumentInputStream stream, |
| final POIFSDocumentPath path, final String documentName, final ClassID storageClassId) { |
| this.stream = stream; |
| this.path = path; |
| this.documentName = documentName; |
| this.storageClassId = storageClassId; |
| } |
| |
| /** |
| * @return the DocumentInputStream, freshly opened |
| */ |
| public DocumentInputStream getStream() { |
| return stream; |
| } |
| |
| /** |
| * @return the document's path |
| */ |
| public POIFSDocumentPath getPath() { |
| return path; |
| } |
| |
| /** |
| * @return the document's name |
| */ |
| public String getName() { |
| return documentName; |
| } |
| |
| /** |
| * @return the storage class id of the path |
| */ |
| public ClassID getStorageClassId() { |
| return storageClassId; |
| } |
| } |