oh-my-posh/website/docs/segments/java.mdx

59 lines
5.1 KiB
Plaintext
Raw Normal View History

2021-03-17 00:16:19 -07:00
---
id: java
title: Java
sidebar_label: Java
---
## What
Display the currently active java version.
## Sample Configuration
2024-01-13 02:11:22 -08:00
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "java",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#ffffff",
background: "#4063D8",
template: " \uE738 {{ .Full }}",
}}
/>
2021-03-17 00:16:19 -07:00
## Properties
2024-01-13 02:11:22 -08:00
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the java version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the java command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present<ul><li>`pom.xml`</li><li>`build.gradle.kts`</li><li>`build.sbt`</li><li>`.java-version`</li><li>`.deps.edn`</li><li>`project.clj`</li><li>`build.boot`</li><li>`*.java`</li><li>`*.class`</li><li>`*.gradle`</li><li>`*.jar`</li><li>`*.clj`</li><li>`*.cljc`</li></ul></li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
2024-01-21 05:14:26 -08:00
| `folders` | `[]string` | allows to override the list of folder names to validate |
2024-01-13 02:11:22 -08:00
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
```template
2022-02-01 03:10:46 -08:00
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
| Name | Type | Description |
| -------- | -------- | -------------------------------------------------- |
| `.Full` | `string` | the full version |
| `.Major` | `string` | major number |
| `.Minor` | `string` | minor number |
| `.Patch` | `string` | patch number |
| `.Error` | `string` | error encountered when fetching the version string |
2022-01-22 10:46:56 -08:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates