{"id":17957234,"url":"https://github.com/supertassu/config","last_synced_at":"2025-04-03T17:28:19.010Z","repository":{"id":98605859,"uuid":"153071954","full_name":"supertassu/config","owner":"supertassu","description":"A java configuration utility","archived":false,"fork":false,"pushed_at":"2018-10-15T07:43:39.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T06:14:48.805Z","etag":null,"topics":["api","config","configuration","hocon","java"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/supertassu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-15T07:39:19.000Z","updated_at":"2018-10-15T11:41:35.000Z","dependencies_parsed_at":"2023-10-04T02:52:49.152Z","dependency_job_id":null,"html_url":"https://github.com/supertassu/config","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supertassu%2Fconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supertassu%2Fconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supertassu%2Fconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supertassu%2Fconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/supertassu","download_url":"https://codeload.github.com/supertassu/config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247045750,"owners_count":20874550,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","config","configuration","hocon","java"],"created_at":"2024-10-29T10:52:30.581Z","updated_at":"2025-04-03T17:28:18.991Z","avatar_url":"https://github.com/supertassu.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Config `1.0.01`\n\nA java configuration utility\n\n## Getting started\n### Add the dependency\n\n```groovy\nrepositories {\n    mavenCentral()\n    maven {\n        name = 'sponge-repo'\n        url = 'https://repo.spongepowered.org/maven'\n    }\n    maven {\n        name = 'tassu-repo'\n        url = 'https://maven.tassu.me/'\n    }\n}\n\ndependencies {\n    // choose one:\n    compile 'me.tassu.cfg:hocon:(version)'\n    compile 'me.tassu.cfg:yaml:(version)'\n}\n```\n\nNo example for Maven because Maven is bad.\n\n### Create the ConfigFactory\n```java\nimport me.tassu.cfg.ConfigFactory;\nimport me.tassu.cfg.impl.HoconConfigFactory;\n\nvoid loadConfig() {\n    final Path path = /* ... */;\n    final ConfigFactory factory = new HoconConfigFactory(path);    \n}\n```\n\n### Create a config class\n```java\npackage me.tassu.publicplugin;\n\nimport com.google.common.collect.ImmutableMap;\nimport com.google.common.collect.Lists;\nimport me.tassu.cfg.AbstractConfig;\nimport me.tassu.cfg.ConfigFactory;\nimport ninja.leaping.configurate.objectmapping.ObjectMapper;\nimport ninja.leaping.configurate.objectmapping.ObjectMappingException;\nimport ninja.leaping.configurate.objectmapping.Setting;\n\nimport java.util.List;\nimport java.util.Map;\n\n@SuppressWarnings(\"FieldCanBeLocal\")\npublic class ExampleConfig extends AbstractConfig\u003cExampleConfig\u003e {\n\n    public ExampleConfig(ConfigFactory factory) {\n        // get configuration loader for \"example.conf\"\n        loader = factory.getLoader(\"example\");\n\n        try {\n            // logic handled by AbstractConfig\n            this.configMapper = ObjectMapper.forObject(this);\n        } catch (ObjectMappingException e) {\n            throw new RuntimeException(e);\n        }\n    }\n\n    @Setting\n    private int exampleInt = 0;\n\n    @Setting\n    private String exampleString = \"Hello!\";\n\n    @Setting(comment = \"Example comment\")\n    private Map\u003cString, String\u003e exampleMap = ImmutableMap.\u003cString, String\u003ebuilder()\n            .put(\"first key\", \"first value\")\n            .put(\"second key\", \"second value\")\n            .build();\n\n    @Setting\n    private List\u003cFloat\u003e exampleList = Lists.newArrayList(1.5f);\n\n    public int getExampleInt() {\n        return exampleInt;\n    }\n\n    public String getExampleString() {\n        return exampleString;\n    }\n\n    public Map\u003cString, String\u003e getExampleMap() {\n        return exampleMap;\n    }\n\n    public List\u003cFloat\u003e getExampleList() {\n        return exampleList;\n    }\n}\n```\n\n### Load and use the configuration\n\n```java\nimport me.tassu.cfg.ConfigFactory;\nimport me.tassu.cfg.impl.HoconConfigFactory;\n\nvoid loadConfig() {\n    final Path path = /* ... */;\n    final ConfigFactory factory = new HoconConfigFactory(path);\n    final ExampleConfig config = new ExampleConfig(factory);\n\n    try {\n        config.load();\n        config.save();\n    } catch (IOException | ObjectMappingException e) {\n        throw new RuntimeException(e);\n    }\n    \n    System.out.println(\"Example int: \" + config.getExampleInt());\n    System.out.println(\"Example string: \" + config.getExampleString());\n    System.out.println(\"Example map: \" + config.getExampleMap());\n    System.out.println(\"Example list: \" + config.getExampleList());\n}\n```\n\n### Result\n```hocon\nexampleInt=0\nexampleList=[\n    1.5\n]\n# Example comment\nexampleMap {\n    \"first key\"=\"first value\"\n    \"second key\"=\"second value\"\n}\nexampleString=\"Hello!\"\n```\n\n# License\n- MIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupertassu%2Fconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupertassu%2Fconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupertassu%2Fconfig/lists"}