Module: JavaProperties

Defined in:

lib/java-properties.rb,
lib/java-properties/version.rb,
lib/java-properties/encoding.rb,
lib/java-properties/properties.rb,
lib/java-properties/parsing/parser.rb,
lib/java-properties/encoding/unicode.rb,
lib/java-properties/parsing/normalizer.rb,
lib/java-properties/encoding/separators.rb,
lib/java-properties/generating/generator.rb,
lib/java-properties/encoding/special_chars.rb

Overview

A module to read and write Java properties files

Defined Under Namespace

Modules: Encoding, Generating, Parsing Classes: Properties

Constant Summary

VERSION =

Current version

"0.0.2".freeze

Class Method Summary

• .generate(hash, options = {}) ⇒ String

  Generates the content of a Java properties file.

• .load(path) ⇒ Properties

  Loads and parses a Java properties file.

• .parse(text) ⇒ Properties

  Parses the content of a Java properties file.

• .write(hash, path, options = {}) ⇒ Object

  Generates a Java properties file.

Class Method Details

.generate(hash, options = {}) ⇒ String

Generates the content of a Java properties file

See Also:

• JavaProperties::Generating::Generator

# File 'lib/java-properties.rb', line 24

def self.generate(hash, options = {})
  Generating::Generator.generate(hash, options)
end

.load(path) ⇒ Properties

Loads and parses a Java properties file

See Also:

• JavaProperties::Parsing::Parser

# File 'lib/java-properties.rb', line 32

def self.load(path)
  parse(File.read(path))
end

.parse(text) ⇒ Properties

Parses the content of a Java properties file

See Also:

• JavaProperties::Parsing::Parser

# File 'lib/java-properties.rb', line 15

def self.parse(text)
  Parsing::Parser.parse(text)
end

.write(hash, path, options = {}) ⇒ Object

Generates a Java properties file

See Also:

• JavaProperties::Generating::Generator

# File 'lib/java-properties.rb', line 41

def self.write(hash, path, options = {})
  File.write(path, generate(hash, options))
end