// Copyright 2014 The Bazel Authors. All rights reserved. // // 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 com.google.devtools.build.lib.skyframe; import com.google.common.base.Preconditions; import com.google.common.collect.Interner; import com.google.devtools.build.lib.cmdline.PackageIdentifier; import com.google.devtools.build.lib.concurrent.BlazeInterners; import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe; import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec; import com.google.devtools.build.lib.util.StringCanonicalizer; import com.google.devtools.build.lib.vfs.PathFragment; import com.google.devtools.build.lib.vfs.Root; import com.google.devtools.build.skyframe.SkyFunctionName; import com.google.devtools.build.skyframe.SkyKey; /** * A descriptor for a glob request, used as the {@link SkyKey} for {@link GlobFunction}. * *
{@code subdir} must be empty or point to an existing directory. * *
{@code pattern} must be valid, as indicated by {@code UnixGlob#checkPatternForError}.
*/
@AutoCodec
@ThreadSafe
public final class GlobDescriptor implements SkyKey {
private static final Interner The glob evaluation code ensures that the boundaries of this package are not crossed.
*/
public PackageIdentifier getPackageId() {
return packageId;
}
/** Returns the package root of {@code getPackageId()}. */
public Root getPackageRoot() {
return packageRoot;
}
/**
* Returns the subdirectory of the package under consideration.
*/
public PathFragment getSubdir() {
return subdir;
}
/**
* Returns the glob pattern under consideration. May contain wildcards.
*
* As the glob evaluator traverses deeper into the file tree, components are added at the
* beginning of {@code subdir} and removed from the beginning of {@code pattern}.
*/
public String getPattern() {
return pattern;
}
/**
* Returns true if directories should be excluded from results.
*/
public boolean excludeDirs() {
return excludeDirs;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof GlobDescriptor)) {
return false;
}
GlobDescriptor other = (GlobDescriptor) obj;
return packageId.equals(other.packageId) && packageRoot.equals(other.packageRoot)
&& subdir.equals(other.subdir) && pattern.equals(other.pattern)
&& excludeDirs == other.excludeDirs;
}
@Override
public int hashCode() {
// Generated instead of Objects.hashCode to avoid intermediate array required for latter.
final int prime = 31;
int result = 1;
result = prime * result + (excludeDirs ? 1231 : 1237);
result = prime * result + packageId.hashCode();
result = prime * result + packageRoot.hashCode();
result = prime * result + pattern.hashCode();
result = prime * result + subdir.hashCode();
return result;
}
@Override
public SkyFunctionName functionName() {
return SkyFunctions.GLOB;
}
}