org.neo4j.server.plugins.ParameterExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-server Show documentation

Neo4j web server.

There is a newer version: 5.26.1

/*
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.server.plugins;

import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.server.rest.repr.BadInputException;

class ParameterExtractor extends DataExtractor
{
    final String name;
    final Class type;
    final boolean optional;
    final String description;
    final TypeCaster caster;

    ParameterExtractor( TypeCaster caster, Class type, Parameter param, Description description )
    {
        this.caster = caster;
        this.type = type;
        this.name = param.name();
        this.optional = param.optional();
        this.description = description == null ? "" : description.value();
    }

    @Override
    Object extract( GraphDatabaseAPI graphDb, Object source, ParameterList parameters ) throws BadInputException
    {
        Object result = caster.get( graphDb, parameters, name );
        if ( optional || result != null ) return result;
        throw new IllegalArgumentException( "Mandatory argument \"" + name + "\" not supplied." );
    }

    @Override
    void describe( ParameterDescriptionConsumer consumer )
    {
        consumer.describeParameter( name, type, optional, description );
    }
}