apoc.help.HelpResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apoc-core Show documentation
Core package for Neo4j Procedures
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 apoc.help;

import java.util.List;
import java.util.Map;
import org.neo4j.procedure.Description;

/**
 * @author mh
 * @since 11.04.16
 */
public class HelpResult {
    @Description("Whether it is a function or a procedure.")
    public String type;

    @Description("The name of the function or procedure.")
    public String name;

    @Description("The description of the function or procedure.")
    public String text;

    @Description("The signature of the function or procedure.")
    public String signature;

    @Description("This value is always null.")
    public List roles;

    @Description("This value is always null.")
    public Boolean writes;

    @Description("If the function or procedure belongs to APOC Core.")
    public Boolean core;

    @Description("If the function or procedure is deprecated.")
    public Boolean isDeprecated;

    public HelpResult(
            String type,
            String name,
            String text,
            String signature,
            List roles,
            Boolean writes,
            Boolean core,
            Boolean isDeprecated) {
        this.type = type;
        this.name = name;
        this.text = text;
        this.signature = signature;
        this.roles = roles;
        this.writes = writes;
        this.core = core;
        this.isDeprecated = isDeprecated;
    }

    public HelpResult(Map row, Boolean core) {
        this(
                (String) row.get("type"),
                (String) row.get("name"),
                (String) row.get("description"),
                (String) row.get("signature"),
                null,
                (Boolean) row.get("writes"),
                core,
                (Boolean) row.get("isDeprecated"));
    }
}