org.graylog.plugins.pipelineprocessor.functions.strings.Length Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.1
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.plugins.pipelineprocessor.functions.strings;

import com.google.common.collect.ImmutableList;
import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.functions.AbstractFunction;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionArgs;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor;
import org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor;

import java.nio.charset.StandardCharsets;
import java.util.Objects;

public class Length extends AbstractFunction {

    public static final String NAME = "length";
    private static final String VALUE = "value";
    private static final String BYTES = "bytes";
    private final ParameterDescriptor valueParam;
    private final ParameterDescriptor bytesParam;

    public Length() {
        valueParam = ParameterDescriptor.string(VALUE).description("The input string").build();
        bytesParam = ParameterDescriptor.bool(BYTES)
                .description("If true, count the bytes of the UTF-8 string instead of the characters")
                .optional().build();
    }

    @Override
    public Long evaluate(FunctionArgs args, EvaluationContext context) {
        final String string = Objects.requireNonNull(valueParam.required(args, context));
        final Boolean bytesFlag = bytesParam.optional(args, context).orElse(Boolean.FALSE);
        if (bytesFlag) {
            return (long) string.getBytes(StandardCharsets.UTF_8).length;
        }
        return (long) string.length();
    }

    @Override
    public FunctionDescriptor descriptor() {
        return FunctionDescriptor.builder()
                .name(NAME)
                .returnType(Long.class)
                .params(ImmutableList.of(valueParam, bytesParam))
                .description("Counts the characters or bytes in a string")
                .build();
    }
}