org.mapfish.print.wrapper.PArray Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of print-lib Show documentation

Library for generating PDFs and images from online webmapping services

There is a newer version: 3.22.0

package org.mapfish.print.wrapper;


/**
 * Array wrapper interface for Json and Yaml parsing.
 */
public interface PArray {
    /**
     * Return the size of the array.
     */
    int size();

    /**
     * Get the element at the index as a object.
     *
     * @param i the index of the object to access
     */
    PObject getObject(int i);

    /**
     * Get the element at the index as a json array.
     *
     * @param i the index of the element to access
     */
    PArray getArray(int i);

    /**
     * Get the element at the index as an integer.
     *
     * @param i the index of the element to access
     */
    int getInt(int i);

    /**
     * Get the element at the index as a long.
     *
     * @param i the index of the element to access
     */
    long getLong(int i);

    /**
     * Get the element at the index as a float.
     *
     * @param i the index of the element to access
     */
    float getFloat(int i);

    /**
     * Get the element at the index as a double.
     *
     * @param i the index of the element to access
     */
    double getDouble(int i);

    /**
     * Get the element at the index as a string.
     *
     * @param i the index of the element to access
     */
    String getString(int i);

    /**
     * Get the element as a boolean.
     *
     * @param i the index of the element to access
     */
    boolean getBool(int i);

    /**
     * Gets the string representation of the path to the current element.
     *
     * @param key the leaf key
     */
    String getPath(String key);

    /**
     * Gets the string representation of the path to the current element.
     */
    String getCurrentPath();

    /**
     * Get the object at the given index.
     *
     * @param i the index of the element to access
     */
    Object get(int i);
}