com.metamx.common.parsers.Parser Maven / Gradle / Ivy
/*
* Copyright 2011,2012 Metamarkets Group Inc.
*
* 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 com.metamx.common.parsers;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Class that can parse Strings into Maps.
*/
public interface Parser
{
/**
* Parse a String into a Map.
*
* @throws ParseException if the String cannot be parsed
*/
public Map parse(String input);
/**
* Set the fieldNames that you expect to see in parsed Maps. Deprecated; Parsers should not, in general, be
* expected to know what fields they will return. Some individual types of parsers do need to know (like a TSV
* parser) and those parsers have their own way of setting field names.
*/
@Deprecated
public void setFieldNames(Iterable fieldNames);
/**
* Returns the fieldNames that we expect to see in parsed Maps, if known, or null otherwise. Deprecated; Parsers
* should not, in general, be expected to know what fields they will return.
*/
@Deprecated
public List getFieldNames();
}