edu.umd.cs.findbugs.sarif.Placeholder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotbugs Show documentation

SpotBugs: Because it's easy!

There is a newer version: 4.9.0

package edu.umd.cs.findbugs.sarif;

import edu.umd.cs.findbugs.BugAnnotation;
import edu.umd.cs.findbugs.ClassAnnotation;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

import java.util.List;
import java.util.Objects;

class Placeholder {
    /**
     * Index of the target {@link edu.umd.cs.findbugs.BugAnnotation} to embed.
     */
    final int index;

    /**
     * Key to formatting {@link edu.umd.cs.findbugs.BugAnnotation}.
     * @see edu.umd.cs.findbugs.BugAnnotation#format(String, ClassAnnotation)
     */
    @NonNull
    final String key;

    Placeholder(int index, @NonNull String key) {
        this.index = index;
        this.key = Objects.requireNonNull(key);
    }

    @NonNull
    String toArgument(List bugAnnotations, @Nullable ClassAnnotation primaryClass) {
        return bugAnnotations.get(index).format(key, primaryClass);
    }
}