Package hudson.model

Class Cause

    • Constructor Detail

      • Cause

        public Cause()
    • Method Detail

      • getShortDescription

        @Exported(visibility=3)
        public abstract String getShortDescription()
        One-line human-readable text of the cause. Historically, this method's return value was used to render HTML on the UI as well. Since Jenkins 2.315 and 2.303.2, the return value is interpreted as text. To have rich HTML output on the UI, provide a custom description.jelly view for your subclass. See the documentation.
      • onAddedTo

        public void onAddedTo​(@NonNull
                              Run build)
        Called when the cause is registered.
        Since:
        1.568
      • onLoad

        public void onLoad​(@NonNull
                           Run<?,​?> build)
        Called when a build is loaded from disk. Useful in case the cause needs to keep a build reference; this ought to be transient.
        Since:
        1.568
      • print

        public void print​(TaskListener listener)
        Report a line to the listener about this cause.
        Since:
        1.362