org.junitpioneer.jupiter.json.Node Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2016-2023 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.jupiter.json;
import java.lang.reflect.Type;
import java.util.Optional;
import java.util.stream.Stream;
/**
* A node representing a JSON structure.
* This class is a Pioneer abstraction which allows using different JSON parsers.
*/
interface Node {
/**
* @return {@code true} if the node represents an array of other nodes
*/
boolean isArray();
/**
* @return all the elements of this potential array node
*/
Stream elements();
/**
* Convert this node into the requested {@code type}
*
* @param type the type into which this node needs to be converted
* @param the type
* @return the converted type
*/
T toType(Type type);
/**
* Get the node value with the given name.
*
* @param name the name of the node
* @return the node for the given name
*/
Optional getNode(String name);
/**
* Get the value of the node.
*
* @param typeHint the potential type of the value
* @return the node value
*/
Object value(Type typeHint);
}