Skip to content

Added format attribute to @Parameter #399

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions src/main/java/org/scijava/command/CommandModuleItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,11 @@ public Number getStepSize() {
}
}

@Override
public String getFormat() {
return getParameter().format();
}

@Override
public int getColumnCount() {
return getParameter().columns();
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/scijava/module/AbstractModuleItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,11 @@ public Number getStepSize() {
return NumberUtils.toNumber("1", getType());
}

@Override
public String getFormat(){
return null;
}

@Override
public int getColumnCount() {
return 6;
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/org/scijava/module/ModuleItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,6 @@ public interface ModuleItem<T> extends BasicDetails {
/** Sets the item's current value with respect to the given module. */
void setValue(Module module, T value);

/** Gets the item's format*/
String getFormat();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new API will break all implementations of ModuleItem (except those extending AbstractModuleItem, of course). It requires increasing the major version of scijava-common to 3.x.x..

}
3 changes: 3 additions & 0 deletions src/main/java/org/scijava/plugin/Parameter.java
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,9 @@
/** Defines the step size to use (numeric parameters only). */
String stepSize() default "";

/** Defines the format to use */
String format() default "";

/** Defines the list of possible values (multiple choice text fields only). */
String[] choices() default {};

Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/scijava/widget/DefaultWidgetModel.java
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,11 @@ public boolean isNumber() {
return Types.isNumber(getItem().getType());
}

@Override
public String getFormat() {
return item.getFormat();
}

@Override
public boolean isBoolean() {
return Types.isBoolean(getItem().getType());
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/scijava/widget/WidgetModel.java
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,11 @@ public interface WidgetModel extends Contextual {
*/
boolean isNumber();

/**
* Gets the format for the value of the model.
*/
String getFormat();

/**
* Gets whether the input is a boolean type (i.e., {@link Boolean} or
* {@code boolean}).
Expand Down
15 changes: 0 additions & 15 deletions src/test/java/org/scijava/command/InvalidCommandTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,6 @@ public void setUp() {
commandService = ctx.getService(CommandService.class);
}

@Test
public void testValid() {
final CommandInfo info = commandService.getCommand(ValidCommand.class);
assertNotNull(info);
assertTrue(info.isValid());

final List<ValidityProblem> problems = info.getProblems();
assertNotNull(problems);
assertEquals(0, problems.size());

final Number stepSize = info.getInput("x").getStepSize();
assertNotNull(stepSize);
assertEquals(10, stepSize.intValue());
}

@Test
public void testInvalid() {
final CommandInfo info = commandService.getCommand(InvalidCommand.class);
Expand Down
101 changes: 101 additions & 0 deletions src/test/java/org/scijava/command/ValidNumberCommandTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2020 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/

package org.scijava.command;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import java.util.List;

import org.junit.Before;
import org.junit.Test;
import org.scijava.Context;
import org.scijava.ItemIO;
import org.scijava.ValidityProblem;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;

/**
* Test commands for verifying that invalid module parameters are dealt with
* using proper error handling.
*
* @author Curtis Rueden
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ctrueden isn't the author of this class, right? I suppose this was just copy-pasted from the other test class?

*/
public class ValidNumberCommandTest {

private CommandService commandService;

@Before
public void setUp() {
Context ctx = new Context(CommandService.class);
commandService = ctx.getService(CommandService.class);
}

@Test
public void testValid() {
final CommandInfo info = commandService.getCommand(ValidCommand.class);
assertNotNull(info);
assertTrue(info.isValid());

final List<ValidityProblem> problems = info.getProblems();
assertNotNull(problems);
assertEquals(0, problems.size());

final Number stepSize = info.getInput("x").getStepSize();
final String format = info.getInput("x").getFormat();
assertNotNull(stepSize);
assertEquals(10, stepSize.intValue());
assertEquals("0.000000", format);
}


// -- Helper classes --

/** A perfectly valid command! */
@Plugin(type = Command.class)
public static class ValidCommand implements Command {

@Parameter(stepSize = "10", format = "0.000000")
private double x;

@Parameter(type = ItemIO.OUTPUT)
private String validOutput;

@Override
public void run() {
validOutput = "ValidCommand: success!";
}

}


}