ConfigReader

java.lang.Object

com.djrapitops.plan.settings.config.ConfigReader

All Implemented Interfaces:: Closeable, AutoCloseable

public class ConfigReader extends Object implements Closeable

Reader for parsing Config out of file-lines.

ConfigReader can read a single file at a time, so it is NOT thread safe.

Constructor Summary

Constructors

Constructor

Description

ConfigReader(BufferedReader bufferedReader)

Create a new ConfigReader for a BufferedReader.

ConfigReader(InputStream in)

Create a new ConfigReader for an InputStream.

ConfigReader(Path filePath)

Create a new ConfigReader for a Path.

ConfigReader(Scanner scanner)

Create a new ConfigReader for a Scanner.
Method Summary

Modifier and Type

Method

Description

void

close()

Config

read()

Read the resource into a Config.

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

Constructor Details
- ConfigReader
  
  public ConfigReader(Path filePath) throws IOException
  
  Create a new ConfigReader for a Path.
  
  Parameters:
  
  filePath - Path to a config file.
  
  Throws:
  
  IOException - If the path can not be read.
- ConfigReader
  
  public ConfigReader(InputStream in)
  
  Create a new ConfigReader for an InputStream.
  
  Parameters:
  
  in - InputStream of a resource that is a config.
- ConfigReader
  
  public ConfigReader(BufferedReader bufferedReader)
  
  Create a new ConfigReader for a BufferedReader.
  
  Parameters:
  
  bufferedReader - BufferedReader of a resource that is a config.
- ConfigReader
  
  public ConfigReader(Scanner scanner)
  
  Create a new ConfigReader for a Scanner.
  
  Parameters:
  
  scanner - Scanner of a resource that is a config.
Method Details
- read
  
  public Config read()
  
  Read the resource into a Config.
  
  Returns:
  
  Config parsed from the lines found in the given resource.
  
  Throws:
  
  IllegalStateException - If the configReader is closed by calling close()
- close
  
  public void close()
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable