net.nemerosa.ontrack.model.structure.Branch.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation
Ontrack module: ontrack-model
There is a newer version: 4.4.5
package net.nemerosa.ontrack.model.structure

import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonView
import net.nemerosa.ontrack.model.form.Form
import net.nemerosa.ontrack.model.form.YesNo

/**
 * Representation of a branch inside a [Project]. They are usually associated
 * to a branch of the SCM associated with the parent project.
 */
data class Branch(
        override val id: ID,
        val name: String,
        override val description: String?,
        @JsonProperty("disabled")
        val isDisabled: Boolean,
        @JsonProperty("project")
        @get:JsonView(value = [
            PromotionView::class, Branch::class, Build::class, PromotionLevel::class, ValidationStamp::class,
            PromotionRun::class, ValidationRun::class, PromotionRunView::class
        ])
        @get:JsonIgnore(false) // Overridding default at [ProjectEntity] level
        override val project: Project,
        override val signature: Signature
) : ProjectEntity {

    fun withId(id: ID) = Branch(id, name, description, isDisabled, project, signature)

    fun withDescription(description: String?) = Branch(id, name, description, isDisabled, project, signature)

    fun withDisabled(isDisabled: Boolean) = Branch(id, name, description, isDisabled, project, signature)

    fun withSignature(signature: Signature) = Branch(id, name, description, isDisabled, project, signature)

    companion object {

        @JvmStatic
        fun of(project: Project, nameDescription: NameDescription) =
                of(project, nameDescription.asState())

        @JvmStatic
        fun of(project: Project, nameDescription: NameDescriptionState) =
                Branch(
                        ID.NONE,
                        nameDescription.name,
                        nameDescription.description,
                        nameDescription.isDisabled,
                        project,
                        Signature.anonymous()
                )

        @JvmStatic
        fun form(): Form = Form.create()
                .with(
                        Form.defaultNameField().length(120)
                )
                .description()
                .with(
                        YesNo.of("disabled").label("Disabled").help("Check if the branch must be disabled.")
                )
    }

    override val projectEntityType: ProjectEntityType = ProjectEntityType.BRANCH

    override val entityDisplayName: String
        get() = "Branch ${project.name}/$name"


    fun toForm(): Form = form()
            .fill("name", name)
            .fill("description", description)
            .fill("disabled", isDisabled)

    fun update(form: NameDescriptionState): Branch =
            of(project, form)
                    .withId(id).withDisabled(form.isDisabled)

}