Java
As a standard bearer for enterprise application development and the native application language for Android, Java is a key language to support for your IBM Cloud service.
Content
Methods
Method parameters MUST be encapsulated into an “options” object that can be constructed with a "Builder".
Streaming
The SDK SHOULD accept parameters with potentially large memory requirements as InputStream
values, to allow the value to be streamed to the service.
Style guidelines
For services that support both a traditional Java SDK and an Android SDK, the Java SDK SHOULD be designed to be Android compatible, to minimize duplication of code.
You should follow a coding style based on the Google Java Style Guide.
You should use the standard development tools for Java to check style and code coverage.
Documentation
Your SDK is not useful if your audience cannot understand how to consume it in order to do the basic operations for your service. Your SDK needs to contain the following resources to help your users:
README.md
- Contributor guidelines
- Code Samples
- Service documentation
Distribution
Package management
Official SDK releases MUST be published in Maven Central.