Package org.rrd4j.core
Class RrdDb.Builder
java.lang.Object
org.rrd4j.core.RrdDb.Builder
- Enclosing class:
RrdDb
Builder for
RrdDb
instances.- Since:
- 3.5
- Author:
- Fabrice Bacchella
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds or imports aRrdDb
instance.void
doimport()
Import an external rrd data, import definition must have been done usingsetExternalPath(String)
orsetImporter(DataImporter)
.readOnly()
Set the rrd as readonlysetBackendFactory
(RrdBackendFactory factory) setExternalPath
(String externalPath) Set when the builder will be used to import external data with a predefined source: XML or RRDTool.setImporter
(DataImporter importer) Set when the builder will be used to import external data with a custom source.Set the pool that will be used and set usePool to true.(package private) RrdDb.Builder
setPoolInternal
(RrdDbPool pool) Internal method used to memorized the pool, without generating a loopsetReadOnly
(boolean readOnly) setRrdToolImporter
(String externalPath) Set when the builder will be used to import a RRDTool file.setUsePool
(boolean usePool) usePool()
Activate the pool usage.
-
Method Details
-
build
Builds or imports aRrdDb
instance.- Returns:
- a new build RrdDb
- Throws:
IOException
- in case of I/O error.IllegalArgumentException
- if the builder settings were incompleteIllegalStateException
- if the thread was interrupted in pool usage
-
doimport
Import an external rrd data, import definition must have been done usingsetExternalPath(String)
orsetImporter(DataImporter)
.It can be used when it's not need to keep a reference to the rrd.
- Throws:
IOException
- in case of I/O error.IllegalArgumentException
- if the builder settings were incompleteIllegalStateException
- if the thread was interrupted in pool usage
-
setPath
-
setPath
-
setBackendFactory
- Parameters:
factory
- The backend factory to use for that rrd.- Returns:
- the same builder.
-
setReadOnly
- Parameters:
readOnly
- true if the rrd is to be read only- Returns:
- the same builder.
-
readOnly
Set the rrd as readonly- Returns:
- the same builder.
-
setUsePool
-
usePool
Activate the pool usage. If the pool is not declared usingsetPool(RrdDbPool)
, the singleton instance will be used.- Returns:
- the same builder.
-
setPool
Set the pool that will be used and set usePool to true.- Parameters:
pool
- true if a pool is going to be used- Returns:
- the same builder.
-
setPoolInternal
Internal method used to memorized the pool, without generating a loop- Parameters:
pool
-- Returns:
-
setExternalPath
Set when the builder will be used to import external data with a predefined source: XML or RRDTool.- Parameters:
externalPath
- an URI-like indication of RRD data to import- Returns:
- the same builder.
-
setImporter
Set when the builder will be used to import external data with a custom source.- Parameters:
importer
- a custom import- Returns:
- the same builder.
-
setRrdToolImporter
Set when the builder will be used to import a RRDTool file.- Parameters:
externalPath
- the path to a RRDTool file- Returns:
- the same builder.
- Throws:
IOException
- if the RRDTool file can‘t be read
-
setRrdDef
- Parameters:
rrdDef
- aRrdDef
to a new rrd file.- Returns:
- the same builder.
-