org.apache.plc4x.java.base.connection.PlcFieldHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plc4j-protocol-driver-base Show documentation

Base classes needed to implement all of the other driver bases.

There is a newer version: 0.6.0

Show newest version

/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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 org.apache.plc4x.java.base.connection;

import org.apache.plc4x.java.api.exceptions.PlcInvalidFieldException;
import org.apache.plc4x.java.api.model.PlcField;
import org.apache.plc4x.java.base.messages.items.BaseDefaultFieldItem;

/**
 * Field Handler which handles the parsing of string to {@link PlcField} and the encoding of retrieved plc values.
 */
public interface PlcFieldHandler {

    PlcField createField(String fieldQuery) throws PlcInvalidFieldException;

    BaseDefaultFieldItem encodeBoolean(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeByte(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeShort(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeInteger(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeBigInteger(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeLong(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeFloat(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeBigDecimal(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeDouble(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeString(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeTime(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeDate(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeDateTime(PlcField field, Object[] values);

    BaseDefaultFieldItem encodeByteArray(PlcField field, Object[] values);

}