ConfigHelper (Hibernate JavaDocs)
Date: 2012-04-05

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hibernate.internal.util
Class ConfigHelper

    java.lang.Object
      org.hibernate.internal.util.ConfigHelper

    public final class ConfigHelper

extends Object

A simple class to centralize logic needed to locate config files on the system.

Method Summary
`static URL` | `findAsResource(String path)` Try to locate a local URL representing the incoming path.
`static Properties` | `getConfigProperties(String path)` Loads a properties instance based on the data at the incoming config location.
`static InputStream` | `getConfigStream(String path)` Open an InputStream to the URL represented by the incoming path.
`static Reader` | `getConfigStreamReader(String path)` Open an Reader to the URL represented by the incoming path.
`static InputStream` | `getResourceAsStream(String resource)`
`static InputStream` | `getUserResourceAsStream(String resource)`
`static URL` | `locateConfig(String path)` Try to locate a local URL representing the incoming path.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### locateConfig

    public static URL locateConfig(String path)

  Try to locate a local URL representing the incoming path. The first attempt assumes that the incoming path is an actual URL string (file://, etc). If this does not work, then the next attempts try to locate this UURL as a java system resource.

  Parameters:
    `path` - The path representing the config location.
  Returns:
    An appropriate URL or null.

### findAsResource

    public static URL findAsResource(String path)

  Try to locate a local URL representing the incoming path. This method only attempts to locate this URL as a java system resource.

  Parameters:
    `path` - The path representing the config location.
  Returns:
    An appropriate URL or null.

### getConfigStream

    public static InputStream getConfigStream(String path)
                                       throws HibernateException

  Open an InputStream to the URL represented by the incoming path. First makes a call to `locateConfig(java.lang.String)` in order to find an appropriate URL. `URL.openStream()` is then called to obtain the stream.

  Parameters:
    `path` - The path representing the config location.
  Returns:
    An input stream to the requested config resource.
  Throws:
    `HibernateException` - Unable to open stream to that resource.

### getConfigStreamReader

    public static Reader getConfigStreamReader(String path)
                                        throws HibernateException

  Open an Reader to the URL represented by the incoming path. First makes a call to `locateConfig(java.lang.String)` in order to find an appropriate URL. `URL.openStream()` is then called to obtain a stream, which is then wrapped in a Reader.

  Parameters:
    `path` - The path representing the config location.
  Returns:
    An input stream to the requested config resource.
  Throws:
    `HibernateException` - Unable to open reader to that resource.

### getConfigProperties

    public static Properties getConfigProperties(String path)
                                          throws HibernateException

  Loads a properties instance based on the data at the incoming config location.

  Parameters:
    `path` - The path representing the config location.
  Returns:
    The loaded properties instance.
  Throws:
    `HibernateException` - Unable to load properties from that resource.

### getResourceAsStream

    public static InputStream getResourceAsStream(String resource)

### getUserResourceAsStream

    public static InputStream getUserResourceAsStream(String resource)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2012 Red Hat, Inc. All Rights Reserved.