01: /* ====================================================================
02: Licensed to the Apache Software Foundation (ASF) under one or more
03: contributor license agreements. See the NOTICE file distributed with
04: this work for additional information regarding copyright ownership.
05: The ASF licenses this file to You under the Apache License, Version 2.0
06: (the "License"); you may not use this file except in compliance with
07: the License. You may obtain a copy of the License at
08:
09: http://www.apache.org/licenses/LICENSE-2.0
10:
11: Unless required by applicable law or agreed to in writing, software
12: distributed under the License is distributed on an "AS IS" BASIS,
13: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: See the License for the specific language governing permissions and
15: limitations under the License.
16: ==================================================================== */
17:
18: package org.apache.poi.poifs.eventfilesystem;
19:
20: import org.apache.poi.poifs.filesystem.DocumentInputStream;
21: import org.apache.poi.poifs.filesystem.POIFSDocumentPath;
22:
23: /**
24: * Class POIFSReaderEvent
25: *
26: * @author Marc Johnson (mjohnson at apache dot org)
27: * @version %I%, %G%
28: */
29:
30: public class POIFSReaderEvent {
31: private DocumentInputStream stream;
32: private POIFSDocumentPath path;
33: private String documentName;
34:
35: /**
36: * package scoped constructor
37: *
38: * @param stream the DocumentInputStream, freshly opened
39: * @param path the path of the document
40: * @param documentName the name of the document
41: */
42:
43: POIFSReaderEvent(final DocumentInputStream stream,
44: final POIFSDocumentPath path, final String documentName) {
45: this .stream = stream;
46: this .path = path;
47: this .documentName = documentName;
48: }
49:
50: /**
51: * @return the DocumentInputStream, freshly opened
52: */
53:
54: public DocumentInputStream getStream() {
55: return stream;
56: }
57:
58: /**
59: * @return the document's path
60: */
61:
62: public POIFSDocumentPath getPath() {
63: return path;
64: }
65:
66: /**
67: * @return the document's name
68: */
69:
70: public String getName() {
71: return documentName;
72: }
73: } // end public class POIFSReaderEvent
|