1    /*
2     *  ====================================================================
3     *  The Apache Software License, Version 1.1
4     *
5     *  Copyright (c) 2000 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" must
28    *  not be used to endorse or promote products derived from this
29    *  software without prior written permission. For written
30    *  permission, please contact apache@apache.org.
31    *
32    *  5. Products derived from this software may not be called "Apache",
33    *  nor may "Apache" appear in their name, without prior written
34    *  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   package org.apache.poi.hpsf;
56   
57   import java.io.*;
58   
59   /**
60    * <p>Factory class to create instances of {@link SummaryInformation},
61    * {@link DocumentSummaryInformation} and {@link PropertySet}.</p>
62    *
63    * @author Rainer Klute (klute@rainer-klute.de)
64    * @version $Id: PropertySetFactory.java,v 1.6 2003/02/01 13:28:28 klute Exp $
65    * @since 2002-02-09
66    */
67   public class PropertySetFactory
68   {
69   
70       /**
71        * <p>Creates the most specific {@link PropertySet} from an {@link
72        * InputStream}. This is preferrably a {@link
73        * DocumentSummaryInformation} or a {@link SummaryInformation}. If
74        * the specified {@link InputStream} does not contain a property
75        * set stream, an exception is thrown and the {@link InputStream}
76        * is repositioned at its beginning.</p>
77        *
78        * @param stream Contains the property set stream's data.
79        * @return The created {@link PropertySet}.
80        * @throws NoPropertySetStreamException if the stream does not
81        * contain a property set.
82        * @throws MarkUnsupportedException if the stream does not support
83        * the <code>mark</code> operation.
84        * @throws UnexpectedPropertySetTypeException if the property
85        * set's type is unexpected.
86        * @throws IOException if some I/O problem occurs.
87        */
88       public static PropertySet create(final InputStream stream)
89   	throws NoPropertySetStreamException, MarkUnsupportedException,
90   	       UnexpectedPropertySetTypeException, IOException
91       {
92           final PropertySet ps = new PropertySet(stream);
93           if (ps.isSummaryInformation())
94               return new SummaryInformation(ps);
95           else if (ps.isDocumentSummaryInformation())
96               return new DocumentSummaryInformation(ps);
97           else
98               return ps;
99       }
100  
101  }
102