RccViolationException          package:R.oo          R Documentation

_A_n _R_c_c_V_i_o_l_a_t_i_o_n_E_x_c_e_p_t_i_o_n _i_n_d_i_c_a_t_e_s _a _v_i_o_l_a_t_i_o_n _o_f _t_h_e _R _C_o_d_i_n_g _C_o_n_v_e_n_t_i_o_n_s (_R_C_C)

_D_e_s_c_r_i_p_t_i_o_n:

     Package:  R.oo 
      *Class RccViolationException*

     'Object'
      '~~|'
      '~~+--''try-error'
      '~~~~~~~|'
      '~~~~~~~+--''condition'
      '~~~~~~~~~~~~|'
      '~~~~~~~~~~~~+--''error'
      '~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~+--''simpleError'
      '~~~~~~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~~~~~~+--''Exception'
      '~~~~~~~~~~~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~~~~~~~~~~~+--''RccViolationException'

     *Directly known subclasses:*


     public static class *RccViolationException*
      extends Exception

     An RccViolationException indicates a violation of the R Coding
     Conventions (RCC). It is generated by 'setConstructorS3()' and
     'setMethodS3()'. It is _not_ meant to be caught, but instead the
     source code that violates the RCC should be fixed. For more
     information about RCC, see references below.

_U_s_a_g_e:

     RccViolationException(...)

_A_r_g_u_m_e_n_t_s:

     ...: Any arguments accepted by the constructor of Exception, i.e.
          one or several 'character' strings, which will be
          concatenated and contain informative message about why the
          RCC was violated.

_D_e_t_a_i_l_s:

     Since it is not possible to assert that the RCC is followed during
     the parsing of the source code, but first only when the source
     code is actually executed.

_F_i_e_l_d_s _a_n_d _M_e_t_h_o_d_s:

     *Methods:*

         'as.character'  Gets a string representing of the RCC violation.
         'getRccUrl'     Static method to get a URL where the RCC can be found.

     *Methods inherited from Exception*:
      as.character, getCall, getLastException, getMessage,
     getStackTrace, getWhen, print, printStackTrace, throw

     *Methods inherited from error*:
      as.character, throw

     *Methods inherited from condition*:
      as.character, conditionCall, conditionMessage, print

     *Methods inherited from Object*:
      $, $<-, [[, [[<-, as.character, attach, attachLocally,
     clearCache, clone, detach, equals, extend, finalize, gc,
     getEnvironment, getFields, getInstanciationTime,
     getStaticInstance, hasField, hashCode, ll, load, objectSize,
     print, save

_A_u_t_h_o_r(_s):

     Henrik Bengtsson (<URL: http://www.braju.com/R/>)

_S_e_e _A_l_s_o:

     See also 'try'() and 'tryCatch()'. For detailed information about
     exceptions see 'Exception'. The R Coding Conventions (RCC) can be
     found at <URL: http://www.maths.lth.se/help/R/RCC/>.

_E_x_a_m_p_l_e_s:

       ## Not run: 
        setConstructorS3("myClass", function() { extends(Object(), .value=0) })
        setMethodS3("MyMethod", "myClass", function(this) { "Hullo!" })
       
     ## End(Not run)
      

