/*
* Copyright 2015-2017 Amazon Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* 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 com.amazonaws.services.dynamodbv2.xspec;
import java.util.LinkedList;
import java.util.List;
import com.amazonaws.annotation.Immutable;
import com.amazonaws.annotation.Beta;
/**
* A path operand that refers to a <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_AttributeValue.html"
* >boolean</a> attribute in DynamoDB; used for building expressions.
* <p>
* Use {@link ExpressionSpecBuilder#BOOL(String)} to instantiate this class.
*/
@Beta
@Immutable
public final class BOOL extends PathOperand {
BOOL(String path) {
super(path);
}
/**
* Returns a <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Comparators"
* >comparator condition</a> (that evaluates to true if the value of the current
* attribute is equal to that of the specified value) for building
* condition expression.
*/
public ComparatorCondition eq(boolean value) {
return new ComparatorCondition("=", this, new LiteralOperand(value));
}
/**
* Returns a <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Comparators"
* >comparator condition</a> (that evaluates to true if the value of the current
* attribute is equal to that of the specified attribute) for building
* condition expression.
*/
public ComparatorCondition eq(BOOL that) {
return new ComparatorCondition("=", this, that);
}
/**
* Returns a <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Comparators"
* >comparator condition</a> (that evaluates to true if the value of the current
* attribute is not equal to that of the specified value) for building
* condition expression.
*/
public ComparatorCondition ne(boolean value) {
return new ComparatorCondition("<>", this, new LiteralOperand(value));
}
/**
* Returns a <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Comparators"
* >comparator condition</a> (that evaluates to true if the value of the current
* attribute is not equal to that of the specified attribute) for building
* condition expression.
*/
public ComparatorCondition ne(BOOL that) {
return new ComparatorCondition("<>", this, that);
}
/**
* Returns an <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Functions"
* >InCondition</a> (that evaluates to true if the value of the current
* attribute is equal to any of the specified values) for
* building condition expression.
*
* @param values
* specified values. The number of values must be at
* least one and at most 100.
*/
public final InCondition in(boolean... values) {
List<LiteralOperand> list = new LinkedList<LiteralOperand>();
for (boolean v: values)
list.add(new LiteralOperand(v));
return new InCondition(this, list);
}
/**
* Returns an <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html#ConditionExpressionReference.Functions"
* >InCondition</a> (that evaluates to true if the value of the current
* attribute is equal to any of the values in the specified list) for
* building condition expression.
*
* @param values
* specified list of values. The number of values must be at
* least one and at most 100.
*/
public InCondition in(List<Boolean> values) {
List<LiteralOperand> list = new LinkedList<LiteralOperand>();
for (Boolean v: values)
list.add(new LiteralOperand(v));
return new InCondition(this, list);
}
/**
* Returns an <code>IfNotExists</code> object which represents an <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html"
* >if_not_exists(path, operand)</a> function call where path refers to that
* of the current path operand; used for building expressions.
*
* <pre>
* "if_not_exists (path, operand) – If the item does not contain an attribute
* at the specified path, then if_not_exists evaluates to operand; otherwise,
* it evaluates to path. You can use this function to avoid overwriting an
* attribute already present in the item."
* </pre>
*
* @param defaultValue
* the default value that will be used as the operand to the
* if_not_exists function call.
*/
public IfNotExistsFunction<BOOL> ifNotExists(boolean defaultValue) {
return new IfNotExistsFunction<BOOL>(this, new LiteralOperand(defaultValue));
}
/**
* Returns an <code>IfNotExists</code> object which represents an <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html"
* >if_not_exists(path, operand)</a> function call where path refers to that
* of the current path operand; used for building expressions.
*
* <pre>
* "if_not_exists (path, operand) – If the item does not contain an attribute
* at the specified path, then if_not_exists evaluates to operand; otherwise,
* it evaluates to path. You can use this function to avoid overwriting an
* attribute already present in the item."
* </pre>
*
* @param defaultValue
* the default value (of another boolean attribute) that will be
* used as the operand to the if_not_exists function call.
*/
public IfNotExistsFunction<BOOL> ifNotExists(BOOL defaultValue) {
return ExpressionSpecBuilder.if_not_exists(this, defaultValue);
}
/**
* Returns a <code>SetAction</code> object used for building update
* expression. If the attribute referred to by this path operand doesn't
* exist, the returned object represents adding the attribute value of the
* specified source path operand to an item. If the current attribute
* already exists, the returned object represents the value replacement of
* the current attribute by the attribute value of the specified source path
* operand.
*/
public SetAction set(BOOL source) {
return new SetAction(this, source);
}
/**
* Returns a <code>SetAction</code> object used for building update
* expression. If the attribute referred to by this path operand doesn't
* exist, the returned object represents adding the specified value as an
* attribute to an item. If the attribute referred to by this path operand
* already exists, the returned object represents the value replacement of
* the current attribute by the specified value.
*/
public SetAction set(boolean value) {
return new SetAction(this, new LiteralOperand(value));
}
/**
* Returns a <code>SetAction</code> object used for building update
* expression. If the attribute referred to by this path operand doesn't
* exist, the returned object represents adding the value of evaluating the
* specified <code>IfNotExists</code> function as an attribute to an item.
* If the attribute referred to by this path operand already exists, the
* returned object represents the value replacement of the current attribute
* by the value of evaluating the specified <code>IfNotExists</code>
* function.
*/
public SetAction set(IfNotExistsFunction<BOOL> ifNotExistsFunction) {
return new SetAction(this, ifNotExistsFunction);
}
}