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.filesystem;
19:
20: /**
21: * Class POIFSWriterEvent
22: *
23: * @author Marc Johnson (mjohnson at apache dot org)
24: * @version %I%, %G%
25: */
26:
27: public class POIFSWriterEvent {
28: private DocumentOutputStream stream;
29: private POIFSDocumentPath path;
30: private String documentName;
31: private int limit;
32:
33: /**
34: * package scoped constructor
35: *
36: * @param stream the DocumentOutputStream, freshly opened
37: * @param path the path of the document
38: * @param documentName the name of the document
39: * @param limit the limit, in bytes, that can be written to the
40: * stream
41: */
42:
43: POIFSWriterEvent(final DocumentOutputStream stream,
44: final POIFSDocumentPath path, final String documentName,
45: final int limit) {
46: this .stream = stream;
47: this .path = path;
48: this .documentName = documentName;
49: this .limit = limit;
50: }
51:
52: /**
53: * @return the DocumentOutputStream, freshly opened
54: */
55:
56: public DocumentOutputStream getStream() {
57: return stream;
58: }
59:
60: /**
61: * @return the document's path
62: */
63:
64: public POIFSDocumentPath getPath() {
65: return path;
66: }
67:
68: /**
69: * @return the document's name
70: */
71:
72: public String getName() {
73: return documentName;
74: }
75:
76: /**
77: * @return the limit on writing, in bytes
78: */
79:
80: public int getLimit() {
81: return limit;
82: }
83: } // end public class POIFSWriterEvent
|