Interface SchemaConvertable<T>

Type Parameters:
T - The type that this codec can encode/decode.
All Known Subinterfaces:
AssetCodec<K,T>, Builder<T>, Codec<T>, DirectDecodeCodec<T>, InheritCodec<T>, ValidatableCodec<T>
All Known Implementing Classes:
ACodecMapCodec, AMapProvidedMapCodec, ArrayCodec, AssetBuilderCodec, AssetCodecMapCodec, BoolDoublePairCodec, BooleanCodec, BsonDocumentCodec, BsonFunctionCodec, BuilderActionAddToTargetMemory, BuilderActionAdjustPortalTimer, BuilderActionAdjustPosition, BuilderActionAppearance, BuilderActionApplyEntityEffect, BuilderActionAttack, BuilderActionBase, BuilderActionBeacon, BuilderActionBlockHitInteraction, BuilderActionChangeTargetRole, BuilderActionClearEncounterBossBar, BuilderActionClearEncounterWeather, BuilderActionCombatAbility, BuilderActionCompleteTask, BuilderActionCrouch, BuilderActionDelayDespawn, BuilderActionDespawn, BuilderActionDie, BuilderActionDisplayName, BuilderActionDropItem, BuilderActionEntityHitInteraction, BuilderActionFlockBeacon, BuilderActionFlockJoin, BuilderActionFlockLeave, BuilderActionFlockSetTarget, BuilderActionFlockState, BuilderActionForEach, BuilderActionGrantReward, BuilderActionIgnoreForAvoidance, BuilderActionInventory, BuilderActionList, BuilderActionLockOnInteractionTarget, BuilderActionLog, BuilderActionMakePath, BuilderActionModelAttachment, BuilderActionMount, BuilderActionNothing, BuilderActionNotify, BuilderActionOpenBarterShop, BuilderActionOpenShop, BuilderActionOverrideAltitude, BuilderActionOverrideAttitude, BuilderActionParentState, BuilderActionPickUpItem, BuilderActionPlaceBlock, BuilderActionPlayAnimation, BuilderActionPlaySound, BuilderActionProjectToGround, BuilderActionRandom, BuilderActionRecomputePath, BuilderActionReleaseTarget, BuilderActionRemove, BuilderActionResetBlockSensors, BuilderActionResetInstructions, BuilderActionResetPath, BuilderActionResetSearchRays, BuilderActionRole, BuilderActionSequence, BuilderActionSetAlarm, BuilderActionSetBlockToPlace, BuilderActionSetEncounterAudioState, BuilderActionSetEncounterBossBar, BuilderActionSetEncounterWeather, BuilderActionSetFlag, BuilderActionSetHealthRegen, BuilderActionSetInteractable, BuilderActionSetInvulnerable, BuilderActionSetLeashPosition, BuilderActionSetMarkedTarget, BuilderActionSetStat, BuilderActionSetTargetNPCInvulnerable, BuilderActionSignalTaggedVolumes, BuilderActionSignalWorldEvent, BuilderActionSpawn, BuilderActionSpawnInteraction, BuilderActionSpawnParticles, BuilderActionStartEncounterMusic, BuilderActionStartObjective, BuilderActionState, BuilderActionStopEncounterMusic, BuilderActionStorePosition, BuilderActionTest, BuilderActionTimeout, BuilderActionTimer, BuilderActionTimerContinue, BuilderActionTimerModify, BuilderActionTimerPause, BuilderActionTimerRestart, BuilderActionTimerStart, BuilderActionTimerStop, BuilderActionToggleStateEvaluator, BuilderActionTriggerSpawnBeacon, BuilderActionTriggerSpawners, BuilderActionWithDelay, BuilderBase, BuilderBaseWithType, BuilderBodyMotionAimCharge, BuilderBodyMotionBase, BuilderBodyMotionCharge, BuilderBodyMotionFind, BuilderBodyMotionFindBase, BuilderBodyMotionFindWithTarget, BuilderBodyMotionFlock, BuilderBodyMotionLand, BuilderBodyMotionLeave, BuilderBodyMotionMaintainDistance, BuilderBodyMotionMatchLook, BuilderBodyMotionMoveAway, BuilderBodyMotionNothing, BuilderBodyMotionPath, BuilderBodyMotionSequence, BuilderBodyMotionTakeOff, BuilderBodyMotionTeleport, BuilderBodyMotionTestProbe, BuilderBodyMotionTimer, BuilderBodyMotionWander, BuilderBodyMotionWanderBase, BuilderBodyMotionWanderInCircle, BuilderBodyMotionWanderInRect, BuilderCodec, BuilderCodecMapCodec, BuilderCombatTargetCollector, BuilderComponent, BuilderDeferrableAction, BuilderEncounterManager, BuilderEncounterManagerAbstract, BuilderEncounterManagerVariant, BuilderEncounterMemberCollector, BuilderEntityFilterAltitude, BuilderEntityFilterAnd, BuilderEntityFilterAttitude, BuilderEntityFilterBase, BuilderEntityFilterCombat, BuilderEntityFilterDeath, BuilderEntityFilterEntityEffect, BuilderEntityFilterExecutingInteraction, BuilderEntityFilterFlock, BuilderEntityFilterHeightDifference, BuilderEntityFilterInsideBlock, BuilderEntityFilterInventory, BuilderEntityFilterItemInHand, BuilderEntityFilterLineOfSight, BuilderEntityFilterMany, BuilderEntityFilterMovementState, BuilderEntityFilterNot, BuilderEntityFilterNPCGroup, BuilderEntityFilterOr, BuilderEntityFilterSpotsMe, BuilderEntityFilterStandingOnBlock, BuilderEntityFilterStat, BuilderEntityFilterViewSector, BuilderEntityFilterWithToggle, BuilderFactory, BuilderHeadMotionAim, BuilderHeadMotionBase, BuilderHeadMotionNothing, BuilderHeadMotionObserve, BuilderHeadMotionRotate, BuilderHeadMotionSequence, BuilderHeadMotionTimer, BuilderHeadMotionWatch, BuilderInstruction, BuilderInstructionRandomized, BuilderInstructionReference, BuilderMotionBase, BuilderMotionControllerBase, BuilderMotionControllerDive, BuilderMotionControllerFly, BuilderMotionControllerMap, BuilderMotionControllerWalk, BuilderMotionSequence, BuilderMotionTimer, BuilderRelativeWaypointDefinition, BuilderRole, BuilderRoleAbstract, BuilderRoleVariant, BuilderSensorAdjustPosition, BuilderSensorAge, BuilderSensorAlarm, BuilderSensorAnd, BuilderSensorAnimation, BuilderSensorAny, BuilderSensorBase, BuilderSensorBeacon, BuilderSensorBlock, BuilderSensorBlockChange, BuilderSensorBlockType, BuilderSensorCanInteract, BuilderSensorCanPlace, BuilderSensorChargeBlockCollisions, BuilderSensorChargeEntityCollisions, BuilderSensorChargeState, BuilderSensorCombatActionEvaluator, BuilderSensorCount, BuilderSensorDamage, BuilderSensorDroppedItem, BuilderSensorEntity, BuilderSensorEntityBase, BuilderSensorEntityEvent, BuilderSensorEntityPrioritiserAttitude, BuilderSensorEntityPrioritiserBase, BuilderSensorEval, BuilderSensorEvent, BuilderSensorFlag, BuilderSensorFlockCombatDamage, BuilderSensorFlockLeader, BuilderSensorGameFlag, BuilderSensorHasHostileTargetMemory, BuilderSensorHasInteracted, BuilderSensorHasTask, BuilderSensorInAir, BuilderSensorInflictedDamage, BuilderSensorInteractionContext, BuilderSensorInWater, BuilderSensorIsBackingAway, BuilderSensorIsBusy, BuilderSensorKill, BuilderSensorLeash, BuilderSensorLight, BuilderSensorMany, BuilderSensorMotionController, BuilderSensorNav, BuilderSensorNot, BuilderSensorOnGround, BuilderSensorOr, BuilderSensorPath, BuilderSensorPlayer, BuilderSensorPoints, BuilderSensorProjectToGround, BuilderSensorRandom, BuilderSensorReadPosition, BuilderSensorSearchRay, BuilderSensorSelf, BuilderSensorState, BuilderSensorSwitch, BuilderSensorTarget, BuilderSensorTime, BuilderSensorTimer, BuilderSensorValueProviderWrapper, BuilderSensorWeather, BuilderSensorWithEntityFilters, BuilderStateTransition, BuilderStateTransitionController, BuilderStateTransitionEdges, BuilderTransientPathDefinition, BuilderValueToParameterMapping, BuilderWeightedAction, ByteCodec, CodecMapCodec, ColorAlphaCodec, ColorCodec, ContainedAssetCodec, DeferredCodec, DependencyTrackingBuilder, DocumentContainingCodec, DoubleArrayCodec, DoubleCodec, EnumCodec, EnumMapCodec, ExecutorMetricsRegistry, Float2ObjectMapCodec, FloatArrayCodec, FloatCodec, FloatRangeArrayCodec, FunctionCodec, HytaleWorldGenProvider.WorldGenBuilderCodec, InetSocketAddressCodec, Int2ObjectMapCodec, Int3ObjectMapCodec, IntArrayCodec, IntegerCodec, InteractionPriorityCodec, IntRangeArrayCodec, LocalizableString.LocalizableStringCodec, LongArrayCodec, LongCodec, MapCodec, MapKeyMapCodec, MapProvidedMapCodec, MergedEnumMapCodec, MetricsRegistry, NullableBooleanCodec, Object2DoubleMapCodec, Object2FloatMapCodec, Object2IntMapCodec, ObjectCodecMapCodec, ObjectMapCodec, RecordCodec, RefCodec, SemverCodec, SemverRangeCodec, SetCodec, Short2FloatMapCodec, Short2ObjectMapCodec, ShortCodec, StoredCodec, StringCodec, StringCodecMapCodec, StringIntegerCodec, SupportConfigBuilder, UUIDBinaryCodec, ValueCodec, Vector2dArrayCodec, Vector3dArrayCodec, Vector3iArrayCodec, WeightedMapCodec
public interface SchemaConvertable<T>
An interface for codecs that can be converted to JSON Schema.

  • Method Summary

    Modifier and Type
    Method
    Description
    Schema
    toSchema(SchemaContext context)
    Returns a schema object that represents this codec as JSON Schema.
    default Schema
    toSchema(SchemaContext context, T def)
    Returns a schema object that represents this codec as JSON Schema.

  • Method Details

    • toSchema

      @Nonnull Schema toSchema(@Nonnull SchemaContext context)
      Returns a schema object that represents this codec as JSON Schema.
      Parameters:
      context - A context to use to assist with creating the schema.
      Returns:
      the generated schema.
      Throws:
      UnsupportedOperationException - if this codec cannot be represented as schema.

    • toSchema

      @Nonnull default Schema toSchema(@Nonnull SchemaContext context, @Nullable T def)
      Returns a schema object that represents this codec as JSON Schema.
      Parameters:
      context - A context to use to assist with creating the schema.
      def - An instance of what this codec can produce which is the default value.
      Returns:
      the generated schema.
      Throws:
      UnsupportedOperationException - if this codec cannot be represented as schema.