You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ActionMetaType.java 1.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. /*
  2. * Copyright (c) 2006-2011 DMDirc Developers
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a copy
  5. * of this software and associated documentation files (the "Software"), to deal
  6. * in the Software without restriction, including without limitation the rights
  7. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. * copies of the Software, and to permit persons to whom the Software is
  9. * furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20. * SOFTWARE.
  21. */
  22. package com.dmdirc.actions.interfaces;
  23. /**
  24. * Encapsulates the methods that all action types are required to implement.
  25. */
  26. public interface ActionMetaType {
  27. /**
  28. * Retrieves the arity of this type.
  29. * @return The arity of this action type
  30. */
  31. int getArity();
  32. /**
  33. * Retrieves the type of arguments that actions of this type should expect.
  34. * @return The type of arguments expected
  35. */
  36. Class[] getArgTypes();
  37. /**
  38. * Retrieves the names of the arguments that actions of this type should
  39. * expect.
  40. * @return The names of the expected arguments
  41. */
  42. String[] getArgNames();
  43. /**
  44. * Retrieves the name of a logical group for this meta-type to be put into.
  45. *
  46. * @return The meta-type's group name
  47. */
  48. String getGroup();
  49. }