blob: 9111ca287669a293adafb7b4ffb43ed4d2da4f82 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
/*
* Copyright 2017, OpenCensus Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opencensus.tags;
import com.google.auto.value.AutoValue;
import io.opencensus.internal.StringUtils;
import io.opencensus.internal.Utils;
import javax.annotation.concurrent.Immutable;
/**
* A validated tag value.
*
* <p>Validation ensures that the {@code String} has a maximum length of {@link #MAX_LENGTH} and
* contains only printable ASCII characters.
*
* @since 0.8
*/
@Immutable
@AutoValue
public abstract class TagValue {
/**
* The maximum length for a tag value. The value is {@value #MAX_LENGTH}.
*
* @since 0.8
*/
public static final int MAX_LENGTH = 255;
TagValue() {}
/**
* Constructs a {@code TagValue} from the given string. The string must meet the following
* requirements:
*
* <ol>
* <li>It cannot be longer than {@link #MAX_LENGTH}.
* <li>It can only contain printable ASCII characters.
* </ol>
*
* @param value the tag value.
* @throws IllegalArgumentException if the {@code String} is not valid.
* @since 0.8
*/
public static TagValue create(String value) {
Utils.checkArgument(isValid(value), "Invalid TagValue: %s", value);
return new AutoValue_TagValue(value);
}
/**
* Returns the tag value as a {@code String}.
*
* @return the tag value as a {@code String}.
* @since 0.8
*/
public abstract String asString();
/**
* Determines whether the given {@code String} is a valid tag value.
*
* @param value the tag value to be validated.
* @return whether the value is valid.
*/
private static boolean isValid(String value) {
return value.length() <= MAX_LENGTH && StringUtils.isPrintableString(value);
}
}
|
