Skip to content

Commit

Permalink
[docs/#71] Add Javadoc for Blueprint entity
Browse files Browse the repository at this point in the history
  • Loading branch information
whitem4rk committed Dec 1, 2024
1 parent 47db023 commit e25bd66
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ public void setAsRemote() {
/**
* Modify.
*
* @param name the name
* @param data the data
* @param name the blueprint name
* @param data the blueprint JSON format with escape handling applied.
*/
public void modify(String name, String data) {
if (name != null) {
Expand All @@ -60,8 +60,8 @@ public void modify(String name, String data) {
/**
* Constructs a new instance
*
* @param name the name of the blueprint
* @param data the raw data of the blueprint in JSON format
* @param name the blueprint name
* @param data the blueprint JSON format with escape handling applied.
* @param isRemote whether the blueprint is copied from remote database
* @param storage the storage to be stored
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
import java.sql.SQLException;
import org.springframework.jdbc.core.RowMapper;

/**
* A RowMapper implementation that maps a row from the result set to a {@link Blueprint} object.
*
* <p>This implementation extracts the "data" column from the
* result set and maps it to the {@code data} field in the {@link Blueprint} object.</p>
*
* @author whitem4rk
* @version 1.0
* @see org.springframework.jdbc.core.RowMapper
*/
public class BlueprintRowMapper implements RowMapper<Blueprint> {

private static final String BLUEPRINT_DATA_COLUMN_NAME = "data";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,24 @@
import org.springframework.stereotype.Repository;

import java.util.List;
import java.util.Optional;

/**
* Repository interface for managing {@link Blueprint} entities.
*
* <p>Extends the {@link JpaRepository} interface to provide CRUD operations and
* additional query methods for {@link Blueprint} objects.</p>
*
* <p>This interface is a Spring Data JPA repository and will be implemented automatically
* by Spring at runtime.</p>
*
* <p>Note: This repository currently does not include QueryDSL integration.
* If you need to perform complex dynamic queries with type safety, you may consider
* adding a custom repository interface and implementing QueryDSL functionality.</p>
*
* @author whitem4rk
* @version 1.0
* @see org.springframework.data.jpa.repository.JpaRepository
*/
@Repository
public interface BlueprintRepository extends JpaRepository<Blueprint, Long> {

Expand Down

0 comments on commit e25bd66

Please sign in to comment.