1 2 /* ==================================================================== 3 * The Apache Software License, Version 1.1 4 * 5 * Copyright (c) 2002 The Apache Software Foundation. All rights 6 * reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. The end-user documentation included with the redistribution, 21 * if any, must include the following acknowledgment: 22 * "This product includes software developed by the 23 * Apache Software Foundation (http://www.apache.org/)." 24 * Alternately, this acknowledgment may appear in the software itself, 25 * if and wherever such third-party acknowledgments normally appear. 26 * 27 * 4. The names "Apache" and "Apache Software Foundation" and 28 * "Apache POI" must not be used to endorse or promote products 29 * derived from this software without prior written permission. For 30 * written permission, please contact apache@apache.org. 31 * 32 * 5. Products derived from this software may not be called "Apache", 33 * "Apache POI", nor may "Apache" appear in their name, without 34 * prior written permission of the Apache Software Foundation. 35 * 36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 39 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 47 * SUCH DAMAGE. 48 * ==================================================================== 49 * 50 * This software consists of voluntary contributions made by many 51 * individuals on behalf of the Apache Software Foundation. For more 52 * information on the Apache Software Foundation, please see 53 * <http://www.apache.org/>. 54 */ 55 56 package org.apache.poi.poifs.filesystem; 57 58 /** 59 * Class POIFSWriterEvent 60 * 61 * @author Marc Johnson (mjohnson at apache dot org) 62 * @version %I%, %G% 63 */ 64 65 public class POIFSWriterEvent 66 { 67 private DocumentOutputStream stream; 68 private POIFSDocumentPath path; 69 private String documentName; 70 private int limit; 71 72 /** 73 * package scoped constructor 74 * 75 * @param stream the DocumentOutputStream, freshly opened 76 * @param path the path of the document 77 * @param documentName the name of the document 78 * @param limit the limit, in bytes, that can be written to the 79 * stream 80 */ 81 82 POIFSWriterEvent(final DocumentOutputStream stream, 83 final POIFSDocumentPath path, final String documentName, 84 final int limit) 85 { 86 this.stream = stream; 87 this.path = path; 88 this.documentName = documentName; 89 this.limit = limit; 90 } 91 92 /** 93 * @return the DocumentOutputStream, freshly opened 94 */ 95 96 public DocumentOutputStream getStream() 97 { 98 return stream; 99 } 100 101 /** 102 * @return the document's path 103 */ 104 105 public POIFSDocumentPath getPath() 106 { 107 return path; 108 } 109 110 /** 111 * @return the document's name 112 */ 113 114 public String getName() 115 { 116 return documentName; 117 } 118 119 /** 120 * @return the limit on writing, in bytes 121 */ 122 123 public int getLimit() 124 { 125 return limit; 126 } 127 } // end public class POIFSWriterEvent 128 129