com.microsoft.semantickernel.implementation.templateengine.tokenizer.blocks.Block Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semantickernel-api Show documentation

Defines the public interface for the Semantic Kernel

There is a newer version: 1.3.0

// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.implementation.templateengine.tokenizer.blocks;

import javax.annotation.Nullable;

/**
 * Base class for blocks parsed from a prompt template
 */
public abstract class Block {

    private final String content;
    private final BlockTypes type;

    /**
     * Base constructor
     *
     * @param content Block content
     * @param type    Block type
     */
    public Block(
        @Nullable String content,
        BlockTypes type) {
        if (content == null) {
            content = "";
        }

        this.content = content;
        this.type = type;
    }

    /**
     * Get the block content
     *
     * @return Block content
     */
    public String getContent() {
        return content;
    }

    /**
     * Check if the block content is valid.
     *
     * @return True if the block content is valid
     */
    public abstract boolean isValid();

    /**
     * Get the block type
     *
     * @return Block type
     */
    public BlockTypes getType() {
        return type;
    }

}