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>
61    *
62    *  Factory class to create instances of {@link SummaryInformation}, {@link
63    *  DocumentSummaryInformation} and {@link PropertySet}.</p>
64    *
65    *@author     Rainer Klute (klute@rainer-klute.de)
66    *@created    May 10, 2002
67    *@version    $Id: PropertySetFactory.java,v 1.4 2002/05/11 14:47:23 acoliver Exp $
68    *@since      2002-02-09
69    */
70   public class PropertySetFactory {
71   
72       /**
73        *  <p>
74        *
75        *  Creates the most specific {@link PropertySet} from an {@link
76        *  InputStream}. This is preferrably a {@link DocumentSummaryInformation}
77        *  or a {@link SummaryInformation}. If the specified {@link InputStream}
78        *  does not contain a property set stream, an exception is thrown and the
79        *  {@link InputStream} is repositioned at its beginning.</p>
80        *
81        *@param  stream                                  Contains the property set
82        *      stream's data.
83        *@return                                         Description of the Return
84        *      Value
85        *@exception  NoPropertySetStreamException        Description of the
86        *      Exception
87        *@exception  MarkUnsupportedException            Description of the
88        *      Exception
89        *@exception  UnexpectedPropertySetTypeException  Description of the
90        *      Exception
91        *@exception  IOException                         Description of the
92        *      Exception
93        */
94       public static PropertySet create(final InputStream stream)
95                throws NoPropertySetStreamException, MarkUnsupportedException,
96               UnexpectedPropertySetTypeException, IOException {
97           final PropertySet ps = new PropertySet(stream);
98           if (ps.isSummaryInformation()) {
99               return new SummaryInformation(ps);
100          } else if (ps.isDocumentSummaryInformation()) {
101              return new DocumentSummaryInformation(ps);
102          } else {
103              return ps;
104          }
105      }
106  
107  }
108