Package com.tnsai.roles.export.frameworks

Class SCOPExporter

java.lang.Object
com.tnsai.roles.export.frameworks.SCOPExporter
All Implemented Interfaces:
RoleExporter
public class SCOPExporter extends Object implements RoleExporter
Stub exporter for SCOP (Spatial Computing and Optimization Platform) format.

Experimental — currently unimplemented. The previous implementation emitted placeholder stub lines directly into generated code, producing files that did not compile out of the box. To avoid shipping broken artefacts, every export method now fails fast with UnsupportedOperationException. The class shell and RoleExporter contract are preserved so a proper SCOP code generator can be added in a future release without breaking the public API surface.

If you need SCOP output today, use JsonRoleExporter or YamlRoleExporter and translate manually.

Author:
TnsAI Team
See Also:

  • Constructor Details

    • SCOPExporter

      public SCOPExporter()
      Creates a SCOPExporter with default package.

    • SCOPExporter

      public SCOPExporter(String packageName)
      Creates a SCOPExporter with custom package. Retained for source compatibility with older callers; the package name is currently ignored because export is unimplemented.
      Parameters:
      packageName - the Java package for generated class (ignored)

  • Method Details

    • export

      public String export(Role role)
      Description copied from interface: RoleExporter
      Exports a Role instance to the target format.
      Specified by:
      export in interface RoleExporter
      Parameters:
      role - the role to export
      Returns:
      exported string representation

    • exportFromClass

      public String exportFromClass(Class<? extends Role> roleClass)
      Description copied from interface: RoleExporter
      Exports a Role class (using annotations) to the target format.
      Specified by:
      exportFromClass in interface RoleExporter
      Parameters:
      roleClass - the role class with annotations
      Returns:
      exported string representation

    • export

      public String export(ExportedRole metadata)
      Description copied from interface: RoleExporter
      Exports role metadata to the target format.
      Specified by:
      export in interface RoleExporter
      Parameters:
      metadata - the extracted role metadata
      Returns:
      exported string representation

    • getFileExtension

      public String getFileExtension()
      Description copied from interface: RoleExporter
      Returns the file extension for this export format.
      Specified by:
      getFileExtension in interface RoleExporter
      Returns:
      file extension (e.g., "json", "yaml", "asl")

    • getMimeType

      public String getMimeType()
      Description copied from interface: RoleExporter
      Returns the MIME type for this export format.
      Specified by:
      getMimeType in interface RoleExporter
      Returns:
      MIME type

    • getFormatName

      public String getFormatName()
      Description copied from interface: RoleExporter
      Returns the format name.
      Specified by:
      getFormatName in interface RoleExporter
      Returns:
      format name (e.g., "JSON", "YAML", "AgentSpeak")