-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove files only applicable to main branch (#122)
* Stable branch does not have a website, build, or changes file * Provide a simplified README
- Loading branch information
1 parent
65f13d7
commit 055916c
Showing
15 changed files
with
6 additions
and
1,091 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1 @@ | ||
|
|
||
| echo "## setup..." | ||
| git config --global user.name "Stephen Colebourne (CI)" | ||
| git config --global user.email "scolebourne@joda.org" | ||
| cd target | ||
|
|
||
| echo "## clone..." | ||
| git clone https://${GITHUB_TOKEN}@github.com/JodaOrg/jodaorg.github.io.git | ||
| cd jodaorg.github.io | ||
| git status | ||
|
|
||
| echo "## copy..." | ||
| rm -rf joda-convert/ | ||
| cp -R ../site joda-convert/ | ||
|
|
||
| echo "## update..." | ||
| git add -A | ||
| git status | ||
| git commit --message "Update joda-convert from CI: $GITHUB_ACTION" | ||
|
|
||
| echo "## push..." | ||
| git push origin main | ||
|
|
||
| echo "## done" | ||
| echo "## do nothing on v2.x" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,9 @@ | ||
| Joda-Convert | ||
| ------------ | ||
|
|
||
| Joda-Convert is a small, highly-focussed [library](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/StringConvert.html), tackling a problem that the JDK should solve - | ||
| providing round-trip conversion between Objects and Strings. | ||
| It is not intended to tackle the wider problem of Object to Object transformation. | ||
| Joda-Convert is a small, highly-focussed library providing round-trip conversion between Objects and Strings. | ||
|
|
||
| ```java | ||
| // conversion to String | ||
| String str = StringConvert.INSTANCE.convertToString(foo); | ||
| This v2.x branch is considered stable and is based on Java 1.6. | ||
| Only backports are applied to this branch. | ||
|
|
||
| // conversion from String | ||
| Foo bar = StringConvert.INSTANCE.convertFromString(Foo.class, str); | ||
| ``` | ||
|
|
||
| Joda-Convert supports two mechanisms of extending the list of supported conversions. | ||
| The first is to write your own [converter](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/TypedStringConverter.html) implementing an interface. | ||
| The second is to use annotations. | ||
|
|
||
| The ability of Joda-Convert to use annotations to define the conversion methods is a key difference from other projects. | ||
| For example, most value classes, like `Currency` or `TimeZone`, already have methods | ||
| to convert to and from a standard format String. | ||
| Consider a `Distance` class annotated with | ||
| [`FromString`](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/FromString.html) and | ||
| [`ToString`](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/ToString.html): | ||
|
|
||
| ```java | ||
| public class Distance { | ||
|
|
||
| @FromString | ||
| public static Distance parse(String str) { ... } | ||
|
|
||
| @ToString | ||
| public String getStandardOutput() { ... } | ||
|
|
||
| } | ||
| ``` | ||
|
|
||
| As shown, the two methods may have any name. They must simply fulfil the required method signatures for conversion. | ||
| The `FromString` annotation may also be applied to a constructor. | ||
|
|
||
| When Joda-Convert is asked to convert between an object and a String, if there is no registered converter | ||
| then the annotations are checked. If they are found, then the methods are called by reflection. | ||
|
|
||
| Joda-Convert is licensed under the business-friendly [Apache 2.0 licence](https://www.joda.org/joda-convert/licenses.html). | ||
|
|
||
|
|
||
| ### Documentation | ||
| Various documentation is available: | ||
|
|
||
| * The [home page](https://www.joda.org/joda-convert/) | ||
| * The helpful [user guide](https://www.joda.org/joda-convert/userguide.html) | ||
| * The [Javadoc](https://www.joda.org/joda-convert/apidocs/index.html) | ||
| * The change notes for the [releases](https://www.joda.org/joda-convert/changes-report.html) | ||
|
|
||
|
|
||
| ### Releases | ||
| [Release 2.2.3](https://www.joda.org/joda-convert/download.html) is the current latest release. | ||
| This release is considered stable and worthy of the 2.x tag. | ||
| The v2.x releases are compatible with v1.x releases, with the exception that the direct Guava dependency is removed. | ||
| It depends on Java SE 6 or later. | ||
|
|
||
| Available in the [Maven Central repository](https://search.maven.org/search?q=g:org.joda%20AND%20a:joda-convert&core=gav) | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### For enterprise | ||
| Available as part of the Tidelift Subscription. | ||
|
|
||
| Joda and the maintainers of thousands of other packages are working with Tidelift to deliver one enterprise subscription that covers all of the open source you use. | ||
|
|
||
| If you want the flexibility of open source and the confidence of commercial-grade software, this is for you. | ||
|
|
||
| [Learn more](https://tidelift.com/subscription/pkg/maven-org-joda-joda-convert?utm_source=maven-org-joda-joda-convert&utm_medium=github) | ||
|
|
||
|
|
||
| ### Support | ||
| Please use [Stack Overflow](https://stackoverflow.com/search?q=joda-convert) for general usage questions. | ||
| GitHub [issues](https://github.com/JodaOrg/joda-convert/issues) and [pull requests](https://github.com/JodaOrg/joda-convert/pulls) | ||
| should be used when you want to help advance the project. | ||
|
|
||
| Any donations to support the project are accepted via [OpenCollective](https://opencollective.com/joda). | ||
|
|
||
| To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). | ||
| Tidelift will coordinate the fix and disclosure. | ||
|
|
||
|
|
||
| ### Release process | ||
|
|
||
| * Update version (README.md, index.md, changes.xml) | ||
| * Commit and push | ||
| * `mvn clean release:clean release:prepare release:perform` | ||
| * `git fetch` | ||
| * Website will be built and released by GitHub Actions | ||
| See the main [home page](https://www.joda.org/joda-convert/) for more info, including the latest supported branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.