Comments (6)
Hi. Thanks for reporting that there's an error in the docs; we'll fix it ASAP. To be clear, it's not that "the Builder object" (as in, the class) really has a lowercase name; the class is called Builder, capitalized like all Java classes. The mistake in the docs is that it is showing the use of a constructor (new LDContext.Builder()
) but instead you are supposed to call a factory method (LDContext.builder()
). This is a static method of the LDContext class, and (again following Java convention) method names are not capitalized.
We definitely need to fix this example code, but for future reference, the most authoritative and complete source for knowing exactly what all of the classes and methods are in the SDK is the generated Javadoc API documentation. Here is the page for LDContext.
from java-server-sdk.
We've fixed the documentation. Thanks again for the report.
from java-server-sdk.
First of all, you are right :)
I've used v5 before it with the object instantiation and when I tried to migrate to v6 with the object construction I didn't notice you are presenting the factory usage so I thought there is a typo here (the convention is that the class name starts with an uppercase letter).
Anyway, for me and for others (trust me :)), the source of information about the SDK is the docs so it's important to update it accordingly.
The auto-generated java docs are not readable so much.
from java-server-sdk.
As I said, we know it is important to have the online docs be correct, and we have updated them. I was not saying they were irrelevant.
I mentioned the auto-generated docs simply because developers sometimes don't notice that they are there. I'm not sure what you mean by "are not readable so much"; they use the Javadoc format which all Java libraries use, which is intended to be convenient for Java developers. If there's something you think is wrong or confusing in the text there, please let us know.
from java-server-sdk.
But I do want to emphasize that the pages at docs.launchdarkly.com are not, and never have been, intended to describe every class or method in the SDK. So if you're ever wondering, for instance, what all of the available methods of the LDContext
are, the generated docs are always the best place to look.
from java-server-sdk.
Eli please do not take me so seriously..
I understand what you are saying, I don't say that I always look only in the official docs, but I try to get the maximum I can take from them, because the java SDK docs in general are not reader freindly. You must agree with me.
So I'm trying not to go there.
Thank you for the fast response and support, I appreciate it :)
from java-server-sdk.
Related Issues (20)
- Annotation to check if a flag is enabled or not HOT 1
- SDK keeps trying to post diagnostics, even when using invalid sdk key HOT 3
- Proper module-info.java HOT 10
- No feature flags loaded after upgrade from 5.6.7 to 5.7.0 HOT 3
- Add stream connection established log HOT 4
- Launch Darkly Metrics conflating Version numbers. HOT 3
- Getting numerous Error posting diagnostic event (giving up permanently): HTTP error 401 (invalid SDK key) HOT 2
- Synk reports the low version of okHttp3 dependency HOT 3
- Vulnerability in snakeyaml HOT 3
- LaunchDarkly Client initialing failed even add LaunchDarkly Certificate to java key store. HOT 9
- `isInitialized` & `dataStore.isInitialized()` HOT 3
- Please provide ability to `LDClient` in non-blocking manner HOT 4
- fat jar brings in duplicate copy of `launchdarkly-logging` HOT 3
- Allow lazily computed defaultValues in LDClient to improve code readability HOT 6
- java-server-sdk is vulnerable to CVE-2022-1471 RCE HOT 3
- Evaluation can throw when the same segment is used in multiple rules within a single flag HOT 6
- Vulnerability CVE-2022-1471 is introduced via SnakeYaml 1.32. Upgrading to 2.0 should fix it. HOT 3
- update to guava 32.0.0 to resolve CVE-2023-2976 HOT 6
- Stream continuously reset HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from java-server-sdk.