Branch class

Named reference to a Commit Represents a branch in memory

Available extensions

Constructors

Branch.new(String branchName, Repository repository)

Properties

branchDirectory Directory

Available on Branch, provided by the BranchCommons extension

Directory of the branchDirectoryPath
no setter
branchDirectoryPath String

Available on Branch, provided by the BranchCommons extension

Path of the branch with the branchName in a Repository
no setter
branchName String
final
branchTreeFilePath String

Available on Branch, provided by the BranchTreeMetaDataStorage extension

Path to BranchTreeMetaData file in a Branch
no setter
branchTreeMetaData BranchTreeMetaData?

Available on Branch, provided by the BranchTreeMetaDataStorage extension

Returns a BranchTreeMetaData for the current Branch If the file is not found it returns null
no setter
branchTreeMetaDataExists bool

Available on Branch, provided by the BranchTreeMetaDataStorage extension

Check if managerFile exists
no setter
hashCode int
The hash code for this object.
no setterinherited
managerFile File

Available on Branch, provided by the BranchTreeMetaDataStorage extension

Actual File of the BranchTreeMetaData of a Branch
no setter
merge Merge

Available on Branch, provided by the BranchCommons extension

Merge file in a Branch
no setter
repository Repository
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
staging Staging

Available on Branch, provided by the BranchCommons extension

Staging file in a Branch
no setter

Methods

addCommit({required Commit commit, dynamic onCommitCreated(CommitTreeMetaData)? = onCommitCreated, dynamic onNoMetaData(Branch)? = onNoCommitBranchMetaData}) → void

Available on Branch, provided by the BranchTree extension

Adds a commit to a managerFile and performs
checkoutToBranch({String? commitSha, dynamic onNoCommitFound()? = onNoCommit, dynamic onSameCommit()? = onSameCommit, dynamic onBranchMetaDataDoesntExists(Branch)? = onNoCommitBranchMetaData, dynamic onStateDoesntExists()? = onStateDoesntExist, dynamic onRepositoryNotInitialized()? = onRepositoryNotInitialized}) → void

Available on Branch, provided by the BranchCreation extension

Checkout to new Branch on a local Repository If the Branch doesn't exist, it will create a new Branch and copy the Files from the exising branch to the current one
createBranch({bool isValidBranchName(String name)?, dynamic onInvalidBranchName(String name)?, dynamic onBranchAlreadyExists()? = onBranchAlreadyExists, dynamic onRepositoryNotInitialized()? = onRepositoryNotInitialized, dynamic onBranchCreated(Directory)? = onBranchCreated}) → void

Available on Branch, provided by the BranchCreation extension

Create a new Branch on a local Repository
deleteBranch({dynamic onBranchDoesntExist()? = onBranchDoesntExists, dynamic onBranchDeleted(Branch)? = onBranchDeleted, dynamic onRepositoryNotInitialized()? = onRepositoryNotInitialized}) → void

Available on Branch, provided by the BranchCreation extension

Delete a Branch from a local Repository It doesn't delete the RepoObjects
getBranchStatus() Map<BranchFileStatus, HashSet<String>>

Available on Branch, provided by the BranchStatus extension

List stages and unstaged files in a working directory on a local Repository
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
saveBranchTreeMetaData(BranchTreeMetaData metaData) BranchTreeMetaData

Available on Branch, provided by the BranchTreeMetaDataStorage extension

Creates a BranchTreeMetaData only if it doesn't exist Update a managerFile with the latest metaData
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited