Skip to content

Commit 2e4ac4f

Browse files
committed
Added javadoc
1 parent 615a832 commit 2e4ac4f

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

src/main/java/org/piwik/java/tracking/CustomVariable.java

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,18 @@
77
package org.piwik.java.tracking;
88

99
/**
10-
*
10+
* A user defined custom variable.
1111
* @author brettcsorba
1212
*/
1313
public final class CustomVariable{
1414
private final String key;
1515
private final String value;
1616

17+
/**
18+
* Create a new CustomVariable
19+
* @param key the key of this CustomVariable
20+
* @param value the value of this CustomVariable
21+
*/
1722
public CustomVariable(String key, String value){
1823
if (key == null){
1924
throw new NullPointerException("Key cannot be null.");
@@ -25,10 +30,18 @@ public CustomVariable(String key, String value){
2530
this.value = value;
2631
}
2732

33+
/**
34+
* Get the key of this CustomVariable
35+
* @return the key of this CustomVariable
36+
*/
2837
public String getKey() {
2938
return key;
3039
}
3140

41+
/**
42+
* Get the value of this CustomVariable
43+
* @return the value of this CustomVariable
44+
*/
3245
public String getValue() {
3346
return value;
3447
}

0 commit comments

Comments
 (0)