main.java.com.amazon.ionpathextraction.pathcomponents.Index Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ion-java-path-extraction Show documentation

Ion Path Extraction API aims to combine the convenience of a DOM API with the speed of a streaming API.

The newest version!

/*
 * Copyright 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 com.amazon.ionpathextraction.pathcomponents;

import com.amazon.ionpathextraction.internal.Annotations;
import com.amazon.ionpathextraction.internal.MatchContext;

/**
 * Index path component matches collection by position, example.
 *  * data: {foo: [1,2,3], bar: { baz: [1] }}
 *
 * search path | callback invoked with reader at
 * ------------|--------------------
 *  (0)        | [1, 2, 3]
 *  (0 2)      | 3
 * 
 */
public final class Index extends PathComponent {

    private final int ordinal;

    /**
     * Constructor.
     *
     * @param ordinal component ordinal.
     */
    public Index(final int ordinal, final String[] annotations) {
        super(new Annotations(annotations));
        this.ordinal = ordinal;
    }

    public Integer getOrdinal() {
        return ordinal;
    }

    @Override
    public boolean innerMatches(final MatchContext context) {
        return ordinal == context.getReaderContainerIndex();
    }
}