• Home
• com.helger.commons
• ph-commons
• 10.2.5
• source code
• IEncoder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.helger.commons.codec.IEncoder Maven / Gradle / Ivy

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.commons.codec;

import javax.annotation.Nullable;

/**
 * The most basic encoding interface
 *
 * @author Philip Helger
 * @param 
 *        Source data type
 * @param 
 *        Destination data type
 */
@FunctionalInterface
public interface IEncoder 
{
  /**
   * Encode the passed source object
   *
   * @param aInput
   *        The source object to be encoded
   * @return The encoded value.
   * @throws EncodeException
   *         In case something goes wrong
   */
  @Nullable
  DSTTYPE getEncoded (@Nullable SRCTYPE aInput);
}