poussecafe.doc.model.ComponentDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pousse-cafe-doc Show documentation
The newest version!
package poussecafe.doc.model;

import java.util.Objects;
import java.util.Optional;
import poussecafe.domain.ValueObject;
import poussecafe.source.model.Documentation;

public class ComponentDoc implements ValueObject {

    public static class Builder {

        private ComponentDoc doc = new ComponentDoc();

        public Builder name(String name) {
            doc.name = name;
            return this;
        }

        public Builder description(String description) {
            doc.description = description;
            return this;
        }

        public Builder shortDescription(Optional shortDescription) {
            doc.shortDescription = shortDescription;
            return this;
        }

        public Builder trivial(boolean trivial) {
            doc.trivial = trivial;
            return this;
        }

        public ComponentDoc build() {
            Objects.requireNonNull(doc.name);
            Objects.requireNonNull(doc.description);
            Objects.requireNonNull(doc.shortDescription);
            return doc;
        }
    }

    private ComponentDoc() {

    }

    private String name;

    public String name() {
        return name;
    }

    private String description;

    public String description() {
        return description;
    }

    private Optional shortDescription = Optional.empty();

    public Optional shortDescription() {
        return shortDescription;
    }

    private boolean trivial;

    public boolean trivial() {
        return trivial;
    }

    public boolean hasDescription() {
        return !description.isEmpty();
    }

    public String shortDescriptionOrDefault() {
        if(shortDescription.isPresent()) {
            return shortDescription.get();
        } else {
            return description.replaceAll("<[a-z\\/]+>", "");
        }
    }

    public DocumentationItem.Builder documentationItemBuilder() {
        return new DocumentationItem.Builder()
                .name(name)
                .description(new Documentation.Builder()
                        .description(description)
                        .shortDescription(shortDescription.orElse(null))
                        .trivial(trivial)
                        .build());
    }
}