aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java b/src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java
new file mode 100644
index 0000000000..3c6f70f181
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java
@@ -0,0 +1,46 @@
+// Copyright 2014 Google Inc. 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.pkgcache;
+
+import com.google.devtools.build.lib.events.Event;
+
+/**
+ * A loaded package that can verify whether it is still up to date.
+ */
+interface LoadedPackage {
+ /**
+ * Returns the actual loaded {@link Package} object.
+ */
+ Package getPackage();
+
+ /**
+ * Returns true iff the entry is still valid.
+ *
+ * <p>An entry is valid when the package it denotes has not been moved, deleted, or changed. This
+ * requires disk I/O to fetch metadata and re-evaluate globs.
+ */
+ boolean isValid() throws InterruptedException;
+
+ /**
+ * Returns true iff the the contents of the package are guaranteed not to have changed after
+ * between {@link #isValid()} calls and syncs of the associated package loader.
+ */
+ boolean contentsCouldNotHaveChanged();
+
+ /**
+ * Returns the set of events (sorted by the order they were reported) that occurred during the
+ * loading of the package.
+ */
+ Iterable<Event> getEvents();
+}