{"id":23439798,"url":"https://github.com/knittl/code-style-java","last_synced_at":"2025-10-08T14:00:03.804Z","repository":{"id":269093656,"uuid":"905910623","full_name":"knittl/code-style-java","owner":"knittl","description":"Opinionated, modern code style for Java","archived":false,"fork":false,"pushed_at":"2025-03-11T06:15:47.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T20:15:46.444Z","etag":null,"topics":["code-style","code-style-guide","java"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/knittl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-12-19T19:12:51.000Z","updated_at":"2025-03-11T06:15:50.000Z","dependencies_parsed_at":"2025-02-15T12:35:46.116Z","dependency_job_id":null,"html_url":"https://github.com/knittl/code-style-java","commit_stats":null,"previous_names":["knittl/java-code-style","knittl/code-style-java"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knittl%2Fcode-style-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knittl%2Fcode-style-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knittl%2Fcode-style-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knittl%2Fcode-style-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/knittl","download_url":"https://codeload.github.com/knittl/code-style-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103870,"owners_count":21048245,"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":["code-style","code-style-guide","java"],"created_at":"2024-12-23T15:36:03.391Z","updated_at":"2025-10-08T13:59:58.743Z","avatar_url":"https://github.com/knittl.png","language":null,"readme":"# Opinionated, modern code style for Java\n\n## Goals\n\n* Readable\n* Clear\n* Expressive\n* Understandable\n* Scanable\n* Minimal diffs\n* Easily edited\n\n\n## Quick Guidelines\n\n* Max 100 - 120 chars per line\n* Prefer `final` (except lambda args)\n* Prefer method references over lambdas\n* Operators on next line\n* Separate (logical) blocks with empty lines\n* Empty line after \"jumps\" (loops, `return`, `break`, `continue`)\n* \"Chop\" long expressions, arguments on separate lines\n* Continued lines indented twice\n* Mark methods without state as `static`\n* Lambdas with a single arg do not use parentheses: `x =\u003e x + 1`\n* Prefer guard clauses over deep nesting\n\n\n# Example\n\n```java\n@Multiple(annotations = \"\")\n@With(\n  several = \"property\",\n  values = {\n    \"one\",\n    \"two\",\n    \"three\"\n  })\npublic class MyClass extends MyBase implements Implementable {\n\n  public static final String CONSTANT_VALUE = \"compile-time-constant\";\n\n  private static final long CLASS_ID = 1337L;\n\n  private final MyDependency dependency;\n\n  public MyClass(final MyDependency dependency) {\n    this.dependency = Objects.requireNonNull(dependency);\n\n    final MyCache myCache = new MyExpiringCache(10, MINUTES);\n    final MyOverlyLongName overlyLongInstance\n        = new MyOverlyLongName(myCache, \"arguments\");\n    final MyThingWithTooManyArgs = new MyThingWithTooManyArgs(\n        myCache,\n        overlyLongInstance,\n        dependency,\n        \"and\",\n        \"some\",\n        \"more\",\n        \"arguments\");\n  }\n\n  public static void doSomethingWithManyParameters(\n      final String action,\n      final int iterations,\n      @Annotated\n      final Object payload) {\n    if (payload == null) {\n      return;\n    }\n\n    if (iterations \u003c 0) {\n      return;\n    }\n\n    for (int i = 0; i \u003c iterations; ++i) {\n      call(action, payload);\n    }\n\n    callAnotherMethodWithManyParameters(\n        action,\n        iterations,\n        \"foo\",\n        \"bar\",\n        13,\n        37);\n  }\n\n  public \u003cT\u003e void streams(final Collection\u003c? extends T\u003e elements) {\n    final List\u003cT\u003e list = elements.stream()\n        .filter(Objects::nonNull)\n        .map(x -\u003e transform(\"mapping\", x))\n        .collect(Collectors.toList());\n\n    dependency.send(list);\n  }\n\n  @Override\n  public boolean equals(final Object other) {\n    return this == other\n        || other instanceof final MyClass that\n        \u0026\u0026 Objects.equals(that.dependency, dependency);\n  }\n\n  @Override\n  public int hashCode() {\n    int hash = Objects.hashCode(dependency);\n    hash = 31 * hash + Objects.hashCode(/*another dependency*/);\n    return result;\n  }\n\n  private static final class NestedClass\n      extends AnotherBase\n      implements Implementable,\n          Nestable {\n    private NestedClass() {\n    }\n\n    public String getName() {\n      return \"name\";\n    }\n\n    public int age() {\n      return 42;\n    }\n  }\n}\n```\n\n\n## Best Practices\n\nAvoid reassigning default values:\n\n```\n// avoid:\nList\u003cString\u003e names = List.of();\nif (config) {\n  names = List.of(config.split(\",\"));\n}\n\n// prefer:\nfinal List\u003cString\u003e names;\nif (config) {\n  names = List.of(config.split(\",\"));\n} else {\n  names = List.of();\n}\n\n// or:\nfinal List\u003cString\u003e names = config\n  ? List.of(config.split(\",\"));\n  : List.of();\n```\n\n\n## Open Discussions\n\n* Star-imports vs explicit imports\n* Naming of getters: Java beans `getValue()` vs record-style `value()`\n* `final` with `instanceof` operator\n* `final` with try-with-resources\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknittl%2Fcode-style-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknittl%2Fcode-style-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknittl%2Fcode-style-java/lists"}