org.springframework.batch.item.file.transform.LineTokenizer.java Source code

Introduction

Here is the source code for org.springframework.batch.item.file.transform.LineTokenizer.java

Source

/*
 * Copyright 2006-2019 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.batch.item.file.transform;

import org.springframework.lang.Nullable;

/**
 * Interface that is used by framework to split string obtained typically from a
 * file into tokens.
 * 
 * @author tomas.slanina
 * @author Mahmoud Ben Hassine
 * 
 */
public interface LineTokenizer {

    /**
     * Yields the tokens resulting from the splitting of the supplied
     * <code>line</code>.
     * 
     * @param line the line to be tokenized (can be <code>null</code>)
     * 
     * @return the resulting tokens
     */
    FieldSet tokenize(@Nullable String line);
}