diff options
Diffstat (limited to 'platform/vcs-api/vcs-api-core/src/com/intellij/openapi/vcs/changes/ContentRevision.java')
-rw-r--r-- | platform/vcs-api/vcs-api-core/src/com/intellij/openapi/vcs/changes/ContentRevision.java | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/platform/vcs-api/vcs-api-core/src/com/intellij/openapi/vcs/changes/ContentRevision.java b/platform/vcs-api/vcs-api-core/src/com/intellij/openapi/vcs/changes/ContentRevision.java new file mode 100644 index 000000000000..de5944ac9b3c --- /dev/null +++ b/platform/vcs-api/vcs-api-core/src/com/intellij/openapi/vcs/changes/ContentRevision.java @@ -0,0 +1,54 @@ +/* + * Copyright 2000-2014 JetBrains s.r.o. + * + * 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.intellij.openapi.vcs.changes; + +import com.intellij.openapi.vcs.FilePath; +import com.intellij.openapi.vcs.VcsException; +import com.intellij.openapi.vcs.history.VcsRevisionNumber; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * @author max + */ +public interface ContentRevision { + /** + * Content of the revision. Implementers are encouraged to lazy implement this especially when it requires connection to the + * version control server or something. + * Might return null in case if file path denotes a directory or content is impossible to retreive. + * + * @return content of the revision + * @throws com.intellij.openapi.vcs.VcsException in case when content retrieval fails + */ + @Nullable + String getContent() throws VcsException; + + /** + * @return file path of the revision + */ + @NotNull + FilePath getFile(); + + /** + * Revision ID. Content revisions with same file path and revision number are considered to be equal and must have same content unless + * {@link VcsRevisionNumber#NULL} is returned. Use {@link VcsRevisionNumber#NULL} when revision number is not applicable like for + * the currently uncommited revision. + * @return revision ID in terms of version control + */ + @NotNull + VcsRevisionNumber getRevisionNumber(); +} |