Skip to content

Commit 3817cf1

Browse files
committed
docs: add javadoc for new label object on the resource group model
1 parent b9feeed commit 3817cf1

File tree

1 file changed

+31
-0
lines changed
  • com.developer.nefarious.zjoule.plugin/src/com/developer/nefarious/zjoule/plugin/models

1 file changed

+31
-0
lines changed

com.developer.nefarious.zjoule.plugin/src/com/developer/nefarious/zjoule/plugin/models/ResourceGroup.java

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,24 +170,55 @@ public void setZoneId(final String zoneId) {
170170
}
171171
}
172172

173+
/**
174+
* Represents a label associated with a resource group.
175+
* <p>
176+
* A label is a key-value pair used for categorizing or tagging resources.
177+
* Labels provide metadata that can be utilized for searching, filtering,
178+
* or organizing resource groups. Each label consists of a unique key and an
179+
* associated value.
180+
* </p>
181+
*/
173182
class Label {
174183

184+
/** The key of the label, representing the category or identifier. */
175185
private String key;
176186

187+
/** The value of the label, providing additional information or context. */
177188
private String value;
178189

190+
/**
191+
* Retrieves the key of the label.
192+
*
193+
* @return the key as a {@link String}.
194+
*/
179195
public String getKey() {
180196
return key;
181197
}
182198

199+
/**
200+
* Sets the key of the label.
201+
*
202+
* @param key the key to set.
203+
*/
183204
public void setKey(final String key) {
184205
this.key = key;
185206
}
186207

208+
/**
209+
* Retrieves the value of the label.
210+
*
211+
* @return the value as a {@link String}.
212+
*/
187213
public String getValue() {
188214
return value;
189215
}
190216

217+
/**
218+
* Sets the value of the label.
219+
*
220+
* @param value the value to set.
221+
*/
191222
public void setValue(final String value) {
192223
this.value = value;
193224
}

0 commit comments

Comments
 (0)