/*
 * Copyright 2020 Google LLC
 *
 * 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.google.cloud.solutions.datalineage.converter;

import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Provides services to read attributes of a structured Message.
 */
public interface MessageParser {

  /**
   * Returns a POJO read at the provided path or null if not found.
   */
  @Nullable
  <T> T read(String path);

  /** Returns a POJO read at the provided path or the provided default value if target is empty. */
  <T> T readOrDefault(String path, T defaultValue);

  /** Returns true if the given key is present in the message. */
  boolean containsKey(String keyPath);
}