org.apache.pulsar.client.api.schema.SchemaDefinition Maven / Gradle / Ivy
/*
* 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.pulsar.client.api.schema;
import java.util.Map;
import java.util.Optional;
import org.apache.pulsar.client.internal.DefaultImplementation;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Interface for schema definition.
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface SchemaDefinition {
/**
* Get a new builder instance that can used to configure and build a {@link SchemaDefinition} instance.
*
* @return the {@link SchemaDefinition}
*/
static SchemaDefinitionBuilder builder() {
return DefaultImplementation.getDefaultImplementation().newSchemaDefinitionBuilder();
}
/**
* Get schema whether always allow null or not.
*
* @return schema always null or not
*/
boolean getAlwaysAllowNull();
/**
* Get JSR310 conversion enabled.
*
* @return return true if enable JSR310 conversion. false means use Joda time conversion.
*/
boolean isJsr310ConversionEnabled();
/**
* Get schema class.
*
* @return schema class
*/
Map getProperties();
/**
* Get json schema definition.
*
* @return schema class
*/
String getJsonDef();
/**
* Get pojo schema definition.
*
* @return pojo schema
*/
Class getPojo();
/**
* Get pojo classLoader.
*
* @return pojo schema
*/
ClassLoader getClassLoader();
/**
* Get supportSchemaVersioning schema definition.
*
* @return the flag of supportSchemaVersioning
*/
boolean getSupportSchemaVersioning();
/**
* Get a configured schema reader.
*
* @return optional containing configured schema reader or empty optional if none is configure
*/
Optional> getSchemaReaderOpt();
/**
* Get a configured schema writer.
*
* @return optional containing configured schema writer or empty optional if none is configure
*/
Optional> getSchemaWriterOpt();
}