import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.collect.ImmutableList;
+import com.google.common.escape.Escaper;
+import com.google.common.escape.Escapers;
+import java.io.IOException;
+import java.io.NotSerializableException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.io.ObjectStreamException;
import java.text.ParseException;
+import java.util.HexFormat;
+import java.util.List;
import java.util.Objects;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.concepts.HierarchicalIdentifier;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.UnresolvedQName;
import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
* as a series of {@link Step}s.
*/
@NonNullByDefault
-public final class ApiPath implements Immutable {
+public record ApiPath(ImmutableList<Step> steps) implements HierarchicalIdentifier<ApiPath> {
+ @java.io.Serial
+ private static final long serialVersionUID = 1L;
+
/**
* A single step in an {@link ApiPath}.
*/
ToStringHelper addToStringAttributes(final ToStringHelper helper) {
return helper.add("module", module).add("identifier", identifier);
}
+
+ void appendTo(final StringBuilder sb) {
+ if (module != null) {
+ sb.append(module).append(':');
+ }
+ sb.append(identifier.getLocalName());
+ }
}
/**
ToStringHelper addToStringAttributes(final ToStringHelper helper) {
return super.addToStringAttributes(helper).add("keyValues", keyValues);
}
+
+ @Override
+ void appendTo(final StringBuilder sb) {
+ super.appendTo(sb);
+ sb.append('=');
+ final var it = keyValues.iterator();
+ while (true) {
+ sb.append(PERCENT_ESCAPER.escape(it.next()));
+ if (it.hasNext()) {
+ sb.append(',');
+ } else {
+ break;
+ }
+ }
+ }
}
- private static final ApiPath EMPTY = new ApiPath(ImmutableList.of());
+ // Escaper based on RFC8040-requirement to percent-encode reserved characters, as defined in
+ // https://tools.ietf.org/html/rfc3986#section-2.2
+ public static final Escaper PERCENT_ESCAPER;
+
+ static {
+ final var hexFormat = HexFormat.of().withUpperCase();
+ final var builder = Escapers.builder();
+ for (char ch : new char[] {
+ // Reserved characters as per https://tools.ietf.org/html/rfc3986#section-2.2
+ ':', '/', '?', '#', '[', ']', '@',
+ '!', '$', '&', '\'', '(', ')', '*', '+', ',', ';', '=',
+ }) {
+ builder.addEscape(ch, "%" + hexFormat.toHighHexDigit(ch) + hexFormat.toLowHexDigit(ch));
+ }
+ PERCENT_ESCAPER = builder.build();
+ }
- private final ImmutableList<Step> steps;
+ private static final ApiPath EMPTY = new ApiPath(ImmutableList.of());
- private ApiPath(final ImmutableList<Step> steps) {
- this.steps = requireNonNull(steps);
+ public ApiPath {
+ requireNonNull(steps);
}
/**
return EMPTY;
}
+ public static ApiPath of(final List<Step> steps) {
+ return steps.isEmpty() ? EMPTY : new ApiPath(ImmutableList.copyOf(steps));
+ }
+
/**
* Parse an {@link ApiPath} from a raw Request URI fragment or another source. The string is expected to contain
* percent-encoded bytes. Any sequence of such bytes is interpreted as a {@code UTF-8}-encoded string. Invalid
return str.isEmpty() ? EMPTY : parseString(ApiPathParser.newUrl(), str);
}
+ /**
+ * Return the {@link Step}s of this path.
+ *
+ * @return Path steps
+ */
public ImmutableList<Step> steps() {
return steps;
}
+ @Override
+ public boolean contains(final ApiPath other) {
+ if (this == other) {
+ return true;
+ }
+ final var oit = other.steps.iterator();
+ for (var step : steps) {
+ if (!oit.hasNext() || !step.equals(oit.next())) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Returns the index of a Step in this path matching specified module and identifier. This method is equivalent to
+ * {@code indexOf(module, identifier, 0)}.
+ *
+ * @param module Requested {@link Step#module()}
+ * @param identifier Requested {@link Step#identifier()}
+ * @return Index of the step in {@link #steps}, or {@code -1} if a matching step is not found
+ * @throws NullPointerException if {@code identifier} is {@code null}
+ */
public int indexOf(final String module, final String identifier) {
- final var m = requireNonNull(module);
+ return indexOf(module, identifier, 0);
+ }
+
+ /**
+ * Returns the index of a Step in this path matching specified module and identifier, starting search at specified
+ * index.
+ *
+ * @param module Requested {@link Step#module()}
+ * @param identifier Requested {@link Step#identifier()}
+ * @param fromIndex index from which to search
+ * @return Index of the step in {@link #steps}, or {@code -1} if a matching step is not found
+ * @throws NullPointerException if {@code identifier} is {@code null}
+ */
+ public int indexOf(final String module, final String identifier, final int fromIndex) {
final var id = requireNonNull(identifier);
- for (int i = 0, size = steps.size(); i < size; ++i) {
+ for (int i = fromIndex, size = steps.size(); i < size; ++i) {
final var step = steps.get(i);
- if (m.equals(step.module) && id.equals(step.identifier.getLocalName())) {
+ if (id.equals(step.identifier.getLocalName()) && Objects.equals(module, step.module)) {
return i;
}
}
public ApiPath subPath(final int fromIndex, final int toIndex) {
final var subList = steps.subList(fromIndex, toIndex);
- if (subList == steps) {
- return this;
- } else if (subList.isEmpty()) {
- return EMPTY;
- } else {
- return new ApiPath(subList);
- }
+ return subList == steps ? this : of(subList);
}
@Override
return obj == this || obj instanceof ApiPath other && steps.equals(other.steps());
}
+ @Override
+ public String toString() {
+ if (steps.isEmpty()) {
+ return "";
+ }
+ final var sb = new StringBuilder();
+ final var it = steps.iterator();
+ while (true) {
+ it.next().appendTo(sb);
+ if (it.hasNext()) {
+ sb.append('/');
+ } else {
+ break;
+ }
+ }
+ return sb.toString();
+ }
+
+ @java.io.Serial
+ Object writeReplace() throws ObjectStreamException {
+ return new APv1(toString());
+ }
+
+ @java.io.Serial
+ private void writeObject(final ObjectOutputStream stream) throws IOException {
+ throw nse();
+ }
+
+ @java.io.Serial
+ private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException {
+ throw nse();
+ }
+
+ @java.io.Serial
+ private void readObjectNoData() throws ObjectStreamException {
+ throw nse();
+ }
+
+ private NotSerializableException nse() {
+ return new NotSerializableException(getClass().getName());
+ }
+
private static ApiPath parseString(final ApiPathParser parser, final String str) throws ParseException {
- final var steps = parser.parseSteps(str);
- return steps.isEmpty() ? EMPTY : new ApiPath(steps);
+ return of(parser.parseSteps(str));
}
}
Code Review / netconf.git / blobdiff