Package com.google.gerrit.server.patch
Class MagicFile
- java.lang.Object
-
- com.google.gerrit.server.patch.MagicFile
-
public abstract class MagicFile extends Object
Representation of a magic file which appears as a file with content to Gerrit users.
-
-
Constructor Summary
Constructors Constructor Description MagicFile()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static MagicFile
forCommitMessage(org.eclipse.jgit.lib.ObjectReader reader, org.eclipse.jgit.lib.AnyObjectId commitId)
static MagicFile
forMergeList(ComparisonType comparisonType, org.eclipse.jgit.lib.ObjectReader reader, org.eclipse.jgit.lib.AnyObjectId commitId)
abstract String
generatedContent()
Generated part of the file.String
getFileContent()
Whole content of the file as it appears to users.int
getStartLineOfModifiableContent()
Returns the start line of the modifiable content.abstract String
modifiableContent()
Non-generated part of the file.
-
-
-
Method Detail
-
forCommitMessage
public static MagicFile forCommitMessage(org.eclipse.jgit.lib.ObjectReader reader, org.eclipse.jgit.lib.AnyObjectId commitId) throws IOException
- Throws:
IOException
-
forMergeList
public static MagicFile forMergeList(ComparisonType comparisonType, org.eclipse.jgit.lib.ObjectReader reader, org.eclipse.jgit.lib.AnyObjectId commitId) throws IOException
- Throws:
IOException
-
generatedContent
public abstract String generatedContent()
Generated part of the file. Any generated contents should go here. Can be empty.
-
modifiableContent
public abstract String modifiableContent()
Non-generated part of the file. This should correspond to some actual content derived from somewhere else which can also be modified (e.g. by suggested fixes). Can be empty.
-
getFileContent
public String getFileContent()
Whole content of the file as it appears to users.
-
getStartLineOfModifiableContent
public int getStartLineOfModifiableContent()
Returns the start line of the modifiable content. Assumes that line counting starts at 1.
-
-