Skip to content

Commit a568b65

Browse files
Add javadocs to public methods (#1187)
1 parent b29ac82 commit a568b65

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

src/main/java/com/google/firebase/remoteconfig/ParameterValue.java

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,14 +205,30 @@ private RolloutValue(String rolloutId, String value, double percent) {
205205
this.percent = percent;
206206
}
207207

208+
/**
209+
* Gets the ID of the Rollout linked to this value.
210+
*
211+
* @return The Rollout ID
212+
*/
208213
public String getRolloutId() {
209214
return rolloutId;
210215
}
211216

217+
/**
218+
* Gets the value that is being rolled out.
219+
*
220+
* @return The rollout value
221+
*/
212222
public String getValue() {
213223
return value;
214224
}
215225

226+
/**
227+
* Gets the rollout percentage representing the exposure of rollout value
228+
* in the target audience.
229+
*
230+
* @return Percentage of audience exposed to the rollout
231+
*/
216232
public double getPercent() {
217233
return percent;
218234
}
@@ -256,6 +272,11 @@ private PersonalizationValue(String personalizationId) {
256272
this.personalizationId = personalizationId;
257273
}
258274

275+
/**
276+
* Gets the ID of the Personalization linked to this value.
277+
*
278+
* @return The Personalization ID
279+
*/
259280
public String getPersonalizationId() {
260281
return personalizationId;
261282
}
@@ -320,10 +341,20 @@ public static ExperimentVariantValue ofNoChange(String variantId) {
320341
return new ExperimentVariantValue(variantId, null, true);
321342
}
322343

344+
/**
345+
* Gets the ID of the experiment variant.
346+
*
347+
* @return The variant ID
348+
*/
323349
public String getVariantId() {
324350
return variantId;
325351
}
326352

353+
/**
354+
* Gets the value of the experiment variant.
355+
*
356+
* @return The variant value
357+
*/
327358
@Nullable
328359
public String getValue() {
329360
return value;
@@ -334,6 +365,11 @@ Boolean getNoChange() {
334365
return noChange;
335366
}
336367

368+
/**
369+
* Returns whether the experiment variant is a no-change variant.
370+
*
371+
* @return true if the experiment variant is a no-change variant, and false otherwise.
372+
*/
337373
public boolean isNoChange() {
338374
return Boolean.TRUE.equals(noChange);
339375
}
@@ -370,10 +406,20 @@ private ExperimentValue(String experimentId, List<ExperimentVariantValue> varian
370406
this.variantValues = variantValues;
371407
}
372408

409+
/**
410+
* Gets the ID of the experiment linked to this value.
411+
*
412+
* @return The Experiment ID
413+
*/
373414
public String getExperimentId() {
374415
return experimentId;
375416
}
376417

418+
/**
419+
* Gets a collection of variant values served by the experiment.
420+
*
421+
* @return List of {@link ExperimentVariantValue}
422+
*/
377423
public List<ExperimentVariantValue> getExperimentVariantValues() {
378424
return variantValues;
379425
}

0 commit comments

Comments
 (0)