Module pro.eng.yui.YuiFramework
Package pro.eng.yui.yuiframe.utils

Interface IEnvPropUtil

public interface IEnvPropUtil
Define common Environment and Properties operations
Since:
1.0.0
Version:
1.0.0
Author:
yui-KITAMURA

  • Method Details

    • getEnv

      @Contract("null -> fail; !null -> new") String getEnv(String key)
      Get System Environment Value stored with key
      Parameters:
      key - system environment variables key
      Returns:
      if exists, then that value, else ""(Empty string)

    • getEnv

      @Contract("null,_ -> fail; !null,_ -> _") String getEnv(String key, String defaultValue)
      Get System Environment Value stored with key. If not exists, then return the defaultValue
      Parameters:
      key - system environment variables key
      defaultValue - default value when the variables not exists
      Returns:
      if exists, then that value, else the defaultValue

    • getProp

      @Contract("null -> fail; !null -> _") String getProp(String key)
      Get properties value.
      Parameters:
      key - properties key
      Returns:
      if exists, then that value, else ""(Empty string)

    • getProp

      @Contract("null,_ -> fail; !null,_ -> _") String getProp(String key, String defaultValue)
      Get properties value. If not exists, then return the defaultValue
      Parameters:
      key - properties key
      defaultValue - default value when the properties not exists
      Returns:
      if exists, then that properties value, else the defaultValue

    • setProp

      @Contract("null,_ -> fail; _,null -> fail; _,_ -> _") void setProp(String key, String value) throws IllegalStateException
      Set properties value. If already exist, then throw exception.
      Parameters:
      key - properties key
      value - set value
      Throws:
      IllegalStateException - Already properties key-value set exists

    • setPropForce

      @Contract("null,_ -> fail; _,null -> fail; _,_ -> _") boolean setPropForce(String key, String value)
      Set properties value. If already exist, then overwrite the value.
      Parameters:
      key - properties key
      value - set value
      Returns:
      true when overwrite