001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.bean.jsonpatch;
018
019import org.apache.juneau.marshall.*;
020
021/**
022 * The JSON Patch {@code "test"} operation per
023 * <a href="https://datatracker.ietf.org/doc/html/rfc6902#section-4.6">RFC 6902 &#167; 4.6</a>.
024 *
025 * <p>
026 * Tests that the value at {@link #getPath() path} equals {@link #getValue() value}.
027 */
028@Marshalled(typeName = "test")
029public class TestOp extends JsonPatchOperation {
030
031   private Object value;
032
033   /**
034    * Default constructor.
035    */
036   public TestOp() {}
037
038   /**
039    * Convenience constructor.
040    *
041    * @param path The JSON Pointer target.  Can be <jk>null</jk> to leave the property unset.
042    * @param value The value to test for.  Can be <jk>null</jk> to leave the property unset.
043    */
044   public TestOp(String path, Object value) {
045      super(path);
046      this.value = value;
047   }
048
049   /**
050    * Bean property getter:  <property>value</property>.
051    *
052    * @return The value of the <property>value</property> property, or <jk>null</jk> if it is not set.
053    */
054   public Object getValue() { return value; }
055
056   /**
057    * Bean property setter:  <property>value</property>.
058    *
059    * @param value The new value for this property.  Can be <jk>null</jk> to unset the property.
060    * @return This object.
061    */
062   public TestOp setValue(Object value) {
063      this.value = value;
064      return this;
065   }
066}