Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(website): add info for java options #1411

Merged
merged 5 commits into from
Jun 24, 2023
Merged

chore(website): add info for java options #1411

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5c8f37
fix-1392 added info for java specific options
SumantxD Jun 16, 2023
fbe1948
added the required changes
SumantxD Jun 22, 2023
2bd5eef
added the required changes
SumantxD Jun 22, 2023
3301967
Merge branch 'fix-1392-add-description-java-specific' of https://gith…
SumantxD Jun 22, 2023
0153a11
Merge branch 'master' into fix-1392-add-description-java-specific
jonaslagoni Jun 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 84 additions & 18 deletions modelina-website/src/components/playground/options/JavaGeneratorOptions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from 'react';
import { debounce } from 'lodash';
import { PlaygroundJavaConfigContext } from '@/components/contexts/PlaygroundConfigContext';
import Select from '@/components/Select';
import InfoModal from '@/components/InfoModal';

interface JavaGeneratorOptionsProps {
setNewConfig?: (queryKey: string, queryValue: string) => void;
Expand Down Expand Up @@ -101,8 +102,15 @@ class JavaGeneratorOptions extends React.Component<
<h3 className="text-lg font-medium leading-6 text-gray-900">
Java Specific options
</h3>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Package Name :">
<p>
In Java, a package name is a way to organize and group related classes and interfaces. It is a naming convention that helps prevent naming conflicts and provides a hierarchical structure to the Java codebase.
<br/><br/>
A package name is written as series of identifiers separated by dots ('.'). Each identifier represents a level in the package hierarchy. For example, a package name could be 'com.example.myapp'.
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Package Name
</span>
Expand All @@ -115,8 +123,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Jackson serialization :">
<p>
Jackson annotations are a set of annotations provided by the Jackson library, which is a popular Java-based JSON processing library. These annotations are used to configure and control how Java objects are serialized to JSON and deserialized from JSON.
<br/><br/>
Annotations in Java are represented by the @ symbol followed by the annotation name.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Jackson serialization
</span>
Expand All @@ -129,8 +144,19 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Marshaling serialization :">
<p>
This option indicates whether the marshal and unmarshal functions would be included in the generated code or not
<br/><br/>
the defalult value is false
<br/><br/>
marshal - this function takes an instance of the class and return a JSON object.
<br/><br/>
unmarshal - this function takes a JSON object and returns an instanve of the class.
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Marshaling serialization
</span>
Expand All @@ -143,8 +169,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Java array type :">
<p>
This option allows you to swithch between rendering collections as List type or Array.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
<br/><br/>
the default value is Array.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Java array type
</span>
Expand All @@ -159,8 +192,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Overwrite HashCode Support :">
<p>
In Java, the hashCode() method is used to generate a unique numeric value (hash code) for an object. The default implementation of hashCode() in the Object class generates hash codes based on the memory address of the object, which may not be suitable for all classes.
<br/><br/>
By enabling the option to overwrite hashCode support, you can provide your own implementation of the hashCode() method in a class. This allows you to define a hash code generation algorithm based on the specific properties and requirements of the class.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Overwrite HashCode Support
</span>
Expand All @@ -173,8 +213,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Overwrite Equal Support :">
<p>
n Java, the equals() method is used to determine if two objects are equal based on their content rather than their memory addresses. The default implementation of equals() in the Object class performs a reference equality check, meaning it only returns true if the compared objects are the same instance in memory.
<br/><br/>
By enabling the option to overwrite equal support, you can provide your own implementation of the equals() method in a class. This allows you to define the equality criteria based on the specific properties and requirements of the class.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Overwrite Equal Support
</span>
Expand All @@ -187,8 +234,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Overwrite toString Support :">
<p>
In Java, the toString() method is used to provide a string representation of an object. The default implementation in the Object class returns a string consisting of the class name, an "@" symbol, and the hexadecimal representation of the object's hash code.
<br/><br/>
By enabling the option to overwrite toString() support, you can define your own implementation of the toString() method for a class. This allows you to provide a more meaningful and customized string representation of the object based on its properties.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Overwrite toString Support
</span>
Expand All @@ -201,8 +255,15 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include javaDocs :">
<p>
Enabling this option will incude the description of the properties as comments in the generated code.
SumantxD marked this conversation as resolved.
Show resolved Hide resolved
<br/><br/>
The default value if false.
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include javaDocs
</span>
Expand All @@ -215,8 +276,13 @@ class JavaGeneratorOptions extends React.Component<
/>
</label>
</li>
<li>
<label className="flex items-center py-2 justify-between cursor-pointer">
<li className=' flex items-center'>
<InfoModal text="Include Javax validation constraints :">
<p>
By using the 'javax.validation.constraints' annotations, you can ensure that the data in your Java object adheres to specific rules and constraints. This helps in validating user input, ensuring data integrity, and facilitating error handling and validation reporting.
</p>
</InfoModal>
<label className="flex flex-grow items-center py-2 justify-between cursor-pointer">
<span className="mt-1 max-w-2xl text-sm text-gray-500">
Include Javax validation constraints
</span>
Expand Down