io.openapiparser.model.ov10.Action Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation

OpenAPI 3.0/3.1 parser

The newest version!

/*
 * Copyright 2024 https://github.com/openapi-processor/openapi-parser
 * PDX-License-Identifier: Apache-2.0
 */

package io.openapiparser.model.ov10;

import io.openapiparser.Context;
import io.openapiparser.Properties;
import io.openapiparser.support.Required;
import io.openapiprocessor.jsonschema.schema.Bucket;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.Map;

import static io.openapiparser.Keywords.*;

/**
 * the Action object.
 *
 * See specification:
 * 4.4.3 Action Object
 */
public class Action extends Properties implements Extensions {

    public Action(Context context, Bucket bucket) {
        super(context, bucket);
    }

    @Required
    public String getTarget() {
        return getStringOrThrow (TARGET);
    }

    public @Nullable String getDescription () {
        return getStringOrNull (DESCRIPTION);
    }

    public @Nullable Object getUpdate () {
        return getRawValue (UPDATE);
    }

    public @Nullable  T getUpdate (Class api) {
        return getObjectOrThrow(UPDATE, api);
    }

    public @Nullable Boolean getRemove () {
        return getBooleanOrNull (REMOVE);
    }

    @Override
    public Map getExtensions() {
        return super.getExtensions ();
    }
}