software.amazon.smithy.model.traits.ClientOptionalTrait Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.smithy.model.traits;

import java.util.Collections;
import software.amazon.smithy.model.SourceLocation;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.model.shapes.ShapeId;

/**
 * Indicates that non-authoritative code generators should treat a member
 * as optional even if it's required or default.
 *
 * Because this trait is added by default to the members of a structure
 * marked with the input trait, this trait can be defined as either
 * synthetic or non-synthetic.
 */
public final class ClientOptionalTrait extends AnnotationTrait {
    public static final ShapeId ID = ShapeId.from("smithy.api#clientOptional");

    public ClientOptionalTrait() {
        this(Node.objectNode());
    }

    public ClientOptionalTrait(ObjectNode node) {
        super(ID, node);
    }

    public ClientOptionalTrait(SourceLocation location) {
        this(new ObjectNode(Collections.emptyMap(), location));
    }

    public static final class Provider extends AnnotationTrait.Provider {
        public Provider() {
            super(ID, ClientOptionalTrait::new);
        }
    }
}