KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > property > PropertyReader


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22 package org.jboss.util.property;
23
24 import java.util.Map JavaDoc;
25
26 import java.io.IOException JavaDoc;
27
28 /**
29  * Iterface used to allow a <tt>PropertyMap</tt> to read property definitions
30  * in an implementation independent fashion.
31  *
32  * @version <tt>$Revision: 1958 $</tt>
33  * @author <a HREF="mailto:jason@planet57.com">Jason Dillon</a>
34  */
35 public interface PropertyReader
36 {
37    /**
38     * Read a map of properties from this input source.
39     *
40     * @return Read properties map.
41     *
42     * @throws PropertyException Failed to read properties.
43     * @throws IOException I/O error while reading properties.
44     */
45    Map JavaDoc readProperties() throws PropertyException, IOException JavaDoc;
46 }
47
Popular Tags