Class/Object

org.ekrich.config.impl

SimpleIncluder

Related Docs: object SimpleIncluder | package impl

Permalink

class SimpleIncluder extends FullIncluder

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleIncluder
  2. FullIncluder
  3. ConfigIncluderClasspath
  4. ConfigIncluderURL
  5. ConfigIncluderFile
  6. ConfigIncluder
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. var fallback: ConfigIncluder

    Permalink
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def include(context: ConfigIncludeContext, name: String): ConfigObject

    Permalink

    Parses another item to be included.

    Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.

    This method is used for a "heuristic" include statement that does not specify file, URL, or classpath resource. If the include statement does specify, then the same class implementing ConfigIncluder must also implement ConfigIncluderClasspath, ConfigIncluderFile, or ConfigIncluderURL as needed, or a default includer will be used.

    context

    some info about the include context

    returns

    a non-null ConfigObject

    Definition Classes
    SimpleIncluderConfigIncluder
  13. def includeFile(context: ConfigIncludeContext, file: File): ConfigObject

    Permalink

    Parses another item to be included.

    Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.

    context

    some info about the include context

    returns

    a non-null ConfigObject

    Definition Classes
    SimpleIncluderConfigIncluderFile
  14. def includeResources(context: ConfigIncludeContext, resource: String): ConfigObject

    Permalink

    Parses another item to be included.

    Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.

    context

    some info about the include context

    returns

    a non-null ConfigObject

    Definition Classes
    SimpleIncluderConfigIncluderClasspath
  15. def includeURL(context: ConfigIncludeContext, url: URL): ConfigObject

    Permalink

    Parses another item to be included.

    Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.

    context

    some info about the include context

    returns

    a non-null ConfigObject

    Definition Classes
    SimpleIncluderConfigIncluderURL
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withFallback(fallback: ConfigIncluder): ConfigIncluder

    Permalink

    Returns a new includer that falls back to the given includer.

    Returns a new includer that falls back to the given includer. This is how you can obtain the default includer; it will be provided as a fallback. It's up to your includer to chain to it if you want to. You might want to merge any files found by the fallback includer with any objects you load yourself.

    It's important to handle the case where you already have the fallback with a "return this", i.e. this method should not create a new object if the fallback is the same one you already have. The same fallback may be added repeatedly.

    fallback

    the previous includer for chaining

    returns

    a new includer

    Definition Classes
    SimpleIncluderConfigIncluder

Inherited from FullIncluder

Inherited from ConfigIncluderClasspath

Inherited from ConfigIncluderURL

Inherited from ConfigIncluderFile

Inherited from ConfigIncluder

Inherited from AnyRef

Inherited from Any

Ungrouped